1. 接口描述
接口请求域名: cds.tencentcloudapi.com 。
查询资产列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeAssetsList。 |
| Version | 是 | String | 公共参数,本接口取值:2018-04-20。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| Limit | 否 | Integer | 限制数目 示例值:10 |
| Offset | 否 | Integer | 偏移量 示例值:0 |
| SearchValues.N | 否 | Array of NameValueString | 实例Id/实例名称/资产名称 |
| AssetsType | 否 | String | 数据资产类型 示例值:MYSQL |
| AssetsAddType | 否 | Integer | 查询的资产类型(1:cdb、2:cvm、3:others) 示例值:1 |
| RegionId | 否 | String | 地域 示例值:ap-guangzhou |
| Permission | 否 | Integer | 审计权限 示例值:-1 |
| AliveStatus | 否 | Integer | 状态 示例值:1 |
| CasbOn | 否 | Integer | 1.代理开启 0.代理关闭 -1.全查 示例值:0 |
| AgentOn | 否 | Integer | 1.Agent开启 0.Agent关闭 -1.全查 示例值:0 |
| CdbOn | 否 | Integer | 0.关闭,1.开启,2.关闭中,3.开启中 -1.全查 示例值:0 |
| ExtendCategory | 否 | String | 扩展分类,如sensitive,指定查询支持敏感数据识别的资产 示例值:sensitive |
| GroupIds.N | 否 | Array of Integer | 资产组Id(Id=0 暂未分组;id>0 组Id) 示例值:[0, 5] |
| Aids.N | 否 | Array of Integer | 资产Id 示例值:[0, 5] |
| BindingState | 否 | Integer | 查询绑定状态(1:查询规则绑定数量;2:查询模型绑定数量) 示例值:2 |
| TrafficMirrorOn | 否 | Integer | 网卡是否开启流量审计 取值范围:[-1, 1] 示例值:-1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 总数目 示例值:100 |
| List | Array of AssetsInfo | 数据列表 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询网卡列表
查询用户是否存在网卡
输入示例
POST / HTTP/1.1
Host: cds.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAssetsList
<公共请求参数>
{
"Limit": 1
}
输出示例
{
"Response": {
"List": [
{
"AddTime": 1773939928,
"AddType": 0,
"AgentOn": 0,
"Aid": 24725,
"AliveStatus": 0,
"AssetGroupId": 0,
"AssetSubnetId": "subnet-akwfpmnm",
"AssetsAddType": 1,
"AssetsIp": "172.16.1.5",
"AssetsName": "cdbrg-eco2ejex",
"AssetsPort": 3306,
"AssetsType": "MySQL",
"AssetsVersion": "8.0",
"AuditCapability": [
{}
],
"Available": "PROXY_OFF",
"BidirectionAllow": 1,
"BidirectionDelivery": 0,
"BidirectionMaxLine": 99,
"BidirectionMaxStorage": 16,
"BidirectionOn": 0,
"CasbOn": 0,
"CdbErrorMsg": "",
"CdbOn": 0,
"DbCharset": "",
"DbPlatform": "64",
"GroupId": "cdbrg-eco2ejex",
"GroupName": "--(暂未分组)",
"InstanceId": "cdbrg-eco2ejex",
"InstanceName": "SSM_ReadOnly",
"IsNewCloudAudit": false,
"OsPolicy": "",
"Permission": 0,
"RegionId": "ap-guangzhou",
"RoStatus": "RoGroup",
"Status": 1,
"TrafficMirrorOn": 0,
"UpdateTime": 1775065531,
"UploadPem": 0,
"VpcId": "vpc-7003sl43"
}
],
"TotalCount": 28,
"RequestId": "45c87ad8-d41c-498d-bdb3-e8efeade4191"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
| FailedOperation | 操作失败。 |
| FailedOperation.DasbAmountNotEnough | 账户余额不足,操作失败。 |
| FailedOperation.DasbErrorCode | Dasb产品操作失败错误码。 |
| FailedOperation.DasbInvalidSecretId | SecretId错误,操作失败。 |
| FailedOperation.DasbInvalidSecretKey | SecretKey错误,操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.ResourceId | 无效的资源ID,用于资源不存在或已过期。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| ResourcesSoldOut | 资源售罄。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.NoPermission | 无操作权限。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |