查询资产列表
最近更新时间: 2026-10-10 00:08:39
1. 接口描述
接口请求域名: cds.api3.fincloud.tencent.com。
查询资产列表
默认接口请求频率限制:20次/秒。
接口更新时间:2026-03-17 13:34:10。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeAssetsList |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-04-20 |
| Region | 是 | 否 | String | 公共参数,地域信息本接口不需要传递此参数。 |
| Limit | 否 | 是 | Int64 | 限制数目 示例值: 10 |
| Offset | 否 | 是 | Int64 | 偏移量 示例值: 0 |
| AssetsAddType | 否 | 是 | Int64 | 查询的资产类型(1:cdb、2:cvm、3:others) 示例值: 1 |
| AgentOn | 否 | 是 | Int64 | 1.Agent开启 0.Agent关闭 -1.全查 示例值: 0 |
| CdbOn | 否 | 是 | Int64 | 0.关闭,1.开启,2.关闭中,3.开启中 -1.全查 示例值: 0 |
| Aids | 否 | 是 | Array of Uint64 | 资产Id 示例值: [0, 5] |
| BindingState | 否 | 是 | Uint64 | 查询绑定状态(1:查询规则绑定数量;2:查询模型绑定数量) 示例值: 2 |
| AssetsType | 否 | 是 | String | 数据资产类型 示例值: MYSQL |
| AliveStatus | 否 | 是 | Int64 | 状态 示例值: 1 |
| ExtendCategory | 否 | 是 | String | 扩展分类,如sensitive,指定查询支持敏感数据识别的资产 示例值: sensitive |
| GroupIds | 否 | 是 | Array of Uint64 | 资产组Id(Id=0 暂未分组;id>0 组Id) 示例值: [0, 5] |
| CasbOn | 否 | 是 | Int64 | 1.代理开启 0.代理关闭 -1.全查 示例值: 0 |
| SearchValues | 否 | 是 | Array of NameValueString | 实例Id/实例名称/资产名称 示例值:查看 |
| RegionId | 否 | 是 | String | 地域 示例值: ap-region |
| Permission | 否 | 是 | Int64 | 审计权限 示例值: -1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| List | Array of AssetsInfo | 数据列表 示例值:查看 |
| TotalCount | Int64 | 总数目 示例值: 100 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.DasbErrorCode | Dasb产品操作失败错误码。 |
| FailedOperation.DasbInvalidSecretId | SecretId错误,操作失败。 |
| FailedOperation.DasbInvalidSecretKey | SecretKey错误,操作失败。 |
| FailedOperation.DasbAmountNotEnough | 账户余额不足,操作失败。 |
| InvalidParameter.ResourceId | 无效的资源ID,用于资源不存在或已过期。 |
| UnauthorizedOperation.NoPermission | 无操作权限。 |
| UnsupportedOperation | 操作不支持。 |
| ResourceInUse | 资源被占用。 |
| UnauthorizedOperation | 未授权操作。 |
| MissingParameter | 缺少参数错误。 |
| InvalidParameter | 参数错误。 |
| AuthFailure | CAM签名/鉴权错误。 |
| InternalError | 内部错误。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInsufficient | 资源不足。 |
| LimitExceeded | 超过配额限制。 |
| ResourceUnavailable | 资源不可用。 |
| ResourceNotFound | 资源不存在。 |
| DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
| OperationDenied | 操作被拒绝。 |
| ResourcesSoldOut | 资源售罄。 |
| InvalidParameterValue | 参数取值错误。 |
| FailedOperation | 操作失败。 |
| UnknownParameter | 未知参数错误。 |
5. 示例
示例1 查询资产列表
查询资产列表
输入示例
POST / HTTP/1.1
Host: cds.api3.fincloud.tencent.com
Content-Type: application/json
X-TC-Action: DescribeAssetsList
<Common Parameters>
{
"Limit": 0,
"Offset": 0,
"SearchValues": [
{
"Name": "InstanceId",
"Value": "test"
}
],
"AssetsType": "MySQL",
"AssetsAddType": 0,
"RegionId": "region",
"Permission": 0,
"AliveStatus": 0,
"CasbOn": 0,
"AgentOn": 0
}
输出示例
{
"Response": {
"TotalCount": 0,
"List": [
{
"AddTime": 1769583553,
"Aid": 1,
"AssetsIp": "10.16.32.75",
"AssetsName": "MyTestAssets",
"AssetsPort": 1,
"AssetsType": "MYSQL",
"AssetsVersion": "1.1",
"AssetsAddType": 1,
"Status": 1,
"UpdateTime": 1,
"VpcId": "vpc-872iu1sd",
"RegionId": "region",
"Permission": 0,
"InstanceId": "cdb-asdsrwef",
"InstanceName": "test-ins",
"AddType": 1,
"AssetSubnetId": "subnet-0943jr1d",
"UploadPem": 0,
"AliveStatus": 0,
"AgentOn": 1,
"CasbOn": 1,
"GroupId": "cdbro-oidsf9023",
"Available": "PROXY_OFF"
}
],
"RequestId": "3303b1cf-6603-4328-8a8b-0c5669a1b098"
}
}