1. 接口描述
接口请求域名： dasb.tencentcloudapi.com 。
查询资产列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDevices。 |
| Version | 是 | String | 公共参数，本接口取值：2019-10-18。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| IdSet.N | 否 | Array of Integer | 资产ID集合 示例值：[1,2] |
| Name | 否 | String | 资产名或资产IP，模糊查询 示例值：运维主机 |
| Ip | 否 | String | 暂未使用 示例值：1.1.1.1 |
| ApCodeSet.N | 否 | Array of String | 地域码集合 示例值：["ap-guangzhou"] |
| Kind | 否 | Integer | 操作系统类型, 1 - Linux, 2 - Windows, 3 - MySQL, 4 - SQLServer, 5 - TDSQL MySQL, 6 - TDSQL-C MySQL, 7 - MariaDB, 8 - PostgreSQL, 9 - MongoDB副本集群, 10 - MongoDB分片集群, 11 - Redis 示例值：1 |
| Offset | 否 | Integer | 分页偏移位置，默认值为0 示例值：0 |
| Limit | 否 | Integer | 每页条目数量，默认20 示例值：10 |
| AuthorizedUserIdSet.N | 否 | Array of Integer | 有该资产访问权限的用户ID集合 示例值：[1,2] |
| ResourceIdSet.N | 否 | Array of String | 过滤条件，资产绑定的堡垒机服务ID集合 示例值：["bh-saas-resource"] |
| KindSet.N | 否 | Array of Integer | 可提供按照多种类型过滤, 取值范围与Kind一致 示例值：[1,2] |
| ManagedAccount | 否 | String | 资产是否包含托管账号。1，包含；0，不包含 示例值：root |
| DepartmentId | 否 | String | 过滤条件，可按照部门ID进行过滤 示例值：1.2 |
| TagFilters.N | 否 | Array of TagFilter | 过滤条件，可按照标签键、标签进行过滤。如果同时指定标签键和标签过滤条件，它们之间为“AND”的关系 示例值：[{"TagKey":"业务部门", "TagValue": ["研发部", "运营部"]}] |
| Filters.N | 否 | Array of Filter | 过滤数组。支持的Name： BindingStatus 绑定状态 示例值：[{"Name":"InstanceId", "Values":["ins-saawadas"]}] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 资产总数 示例值：10 |
| DeviceSet | Array of Device | 资产信息列表 示例值：[{"Id":1,"Name":"运维主机"}] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询资产列表
查询资产列表
输入示例
POST / HTTP/1.1
Host: dasb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDevices
<公共请求参数>
{}输出示例
{
"Response": {
"TotalCount": 1,
"DeviceSet": [
{
"Id": 1,
"InstanceId": "ins-bhtest",
"Name": "test-name",
"PublicIp": "10.10.10.10",
"PrivateIp": "127.0.0.1",
"ApCode": "ap-guangzhou",
"OsName": "Linux",
"Kind": 1,
"Port": 1,
"GroupSet": [
{
"Id": 1,
"Name": "test-group-name",
"Department": {
"Id": "1",
"Name": "1",
"Managers": [
"1"
],
"ManagerUsers": [
{
"ManagerId": "1",
"ManagerName": "test-name"
}
]
},
"Count": 1
}
],
"AccountCount": 1,
"VpcId": "vpc-bhtest",
"SubnetId": "subnet-bhtest",
"Resource": {
"ResourceId": "bh-saas-test",
"ApCode": "ap-guangzhou",
"SvArgs": "sv_cds_dasb_saas_standard_50node",
"VpcId": "vpc-bhtest",
"Nodes": 1,
"RenewFlag": 1,
"ExpireTime": "2020-09-22T00:00:00+08:00",
"Status": 1,
"ResourceName": "test-name",
"Pid": 1,
"CreateTime": "2020-09-22T00:00:00+08:00",
"ProductCode": "code",
"SubProductCode": "code",
"Zone": "ap-guangzhou-1",
"Expired": true,
"Deployed": true,
"VpcName": "vpc-name",
"VpcCidrBlock": "192.168.11.0/24",
"SubnetId": "subnet-bhtest",
"SubnetName": "test-name",
"CidrBlock": "192.168.11.0/24",
"PublicIpSet": [
"10.10.10.10"
],
"PrivateIpSet": [
"192.168.0.1"
],
"ModuleSet": [
""
],
"UsedNodes": 1,
"ExtendPoints": 1,
"PackageBandwidth": 1,
"PackageNode": 1,
"LogDeliveryArgs": "sv_cds_dasb_saas_wafdsd",
"LogDelivery": "sc_cds_dasb_saas_aswafa"
},
"Department": {
"Id": "1",
"Name": "1",
"Managers": [
"1"
],
"ManagerUsers": [
{
"ManagerId": "1",
"ManagerName": "1"
}
]
},
"IpPortSet": [
""
]
}
],
"RequestId": "ec7676f4-a498-4ef5-ad68-6678b16e45d7"
}
}示例2 根据用户查询有访问权限的资产
根据用户查询有访问权限的资产
输入示例
POST / HTTP/1.1
Host: dasb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDevices
<公共请求参数>
{
"AuthorizedUserIdSet": [
1,
7,
8
],
"Name": "bhtest"
}输出示例
{
"Response": {
"TotalCount": 1,
"DeviceSet": [
{
"Id": 1,
"InstanceId": "ins-bhtest",
"Name": "test-device-name",
"PublicIp": "10.10.10.10",
"PrivateIp": "127.0.0.1",
"ApCode": "ap-guangzhou",
"OsName": "Linux",
"Kind": 1,
"Port": 1,
"GroupSet": [
{
"Id": 1,
"Name": "test-group-name",
"Department": {
"Id": "1",
"Name": "1",
"Managers": [
"1"
],
"ManagerUsers": [
{
"ManagerId": "1",
"ManagerName": "test-name"
}
]
},
"Count": 1
}
],
"AccountCount": 1,
"VpcId": "vpc-bhtest",
"SubnetId": "subnet-bhtest",
"Resource": {
"ResourceId": "bh-saas-bhtest",
"ApCode": "ap-guangzhou",
"SvArgs": "sv_cds_dasb_saas_standard_50node",
"VpcId": "vpc-bhtest",
"Nodes": 1,
"RenewFlag": 1,
"ExpireTime": "2020-09-22T00:00:00+08:00",
"Status": 1,
"ResourceName": "test-name",
"Pid": 1,
"CreateTime": "2020-09-22T00:00:00+08:00",
"ProductCode": "code",
"SubProductCode": "code",
"Zone": "ap-guangzhou-1",
"Expired": true,
"Deployed": true,
"VpcName": "vpc-name",
"VpcCidrBlock": "192.168.11.0/24",
"SubnetId": "subnet-bhtest",
"SubnetName": "test-sub-name",
"CidrBlock": "192.168.11.0/24",
"PublicIpSet": [
"10.10.10.10"
],
"PrivateIpSet": [
"192.168.0.1"
],
"ModuleSet": [
""
],
"UsedNodes": 1,
"ExtendPoints": 1,
"PackageBandwidth": 1,
"PackageNode": 1,
"LogDeliveryArgs": "sv_cds_dasb_saas_asdawsdf",
"LogDelivery": "sc_cds_dasb_saas_sadfsdggf"
},
"Department": {
"Id": "1",
"Name": "1",
"Managers": [
"1"
],
"ManagerUsers": [
{
"ManagerId": "1",
"ManagerName": "1"
}
]
},
"IpPortSet": [
""
]
}
],
"RequestId": "ec7676f4-a498-4ef5-ad68-6678b16e45d7"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| ResourceNotFound | 资源不存在。 |
| UnsupportedOperation | 操作不支持。 |
