查询Agent列表
最近更新时间: 2026-10-10 00:08:39
1. 接口描述
接口请求域名： cds.api3.fincloud.tencent.com。
查询Agent列表
默认接口请求频率限制：20次/秒。
接口更新时间：2026-01-28 15:05:22。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeAgentList |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-04-20 |
| Region | 是 | 否 | String | 公共参数，地域信息本接口不需要传递此参数。 |
| RegionId | 否 | 是 | String | 地域 示例值： ap-region |
| AssetsId | 否 | 是 | Int64 | 资产 ID 示例值： 1 |
| AgentStatus | 否 | 是 | Int64 | 运行状态 示例值： 1 |
| DeployIp | 否 | 是 | String | 部署ip 示例值： 10.14.102.56 |
| Limit | 否 | 是 | Int64 | 限制数目 示例值： 1 |
| Offset | 否 | 是 | Int64 | 偏移量 示例值： 1 |
| TrafficType | 否 | 是 | Int64 | 流量来源 示例值： 1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| List | Array of AuditAgentInfo | Agent列表数组 示例值：查看 |
| TotalCount | Uint64 | 总数目 示例值： 11 |
| 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 查询Agent列表
输入示例
POST / HTTP/1.1
Host: cds.api3.fincloud.tencent.com
Content-Type: application/json
X-TC-Action: DescribeAgentList
<Common Parameters>
{
"TrafficType": 0,
"RegionId": "ap-region",
"AssetsId": 0,
"AgentStatus": 0,
"DeployIp": "10.24.16.39",
"Limit": 10,
"Offset": 0
}
输出示例
{
"Response": {
"TotalCount": 1,
"List": [
{
"DeployIp": "10.24.16.39",
"TrafficType": 1,
"VpcId": "vpc-89jq1d75",
"RegionId": "ap-region",
"SystemType": 1,
"MemoryUsage": 1,
"CpuUsage": 1,
"AgentStatus": 1,
"AddTime": 1769583553,
"AgentId": 1,
"AgentName": "MyDevAgent",
"AgentPid": 1,
"AgentRuntimeTime": 1769583553,
"AgentShutdownTime": 1769583553,
"AgentUpdate": 1,
"AssetsIds": "ins-2u1iqw5",
"AssetsList": [
{
"AddTime": 1769583553,
"Aid": 1,
"AssetsIp": "10.34.19.45",
"AssetsName": "MyDevAssets",
"AssetsPort": 3306,
"AssetsType": "MySQL",
"AssetsVersion": "8.0",
"AssetsAddType": 1,
"Status": 1,
"UpdateTime": 1769583553,
"VpcId": "vpc-82kj124f",
"RegionId": "ap-region",
"Permission": 0,
"InstanceId": "ins-219ijks9",
"InstanceName": "MyDevInstance",
"AddType": 1,
"AssetSubnetId": "subnet-89j21jkr",
"UploadPem": 0,
"AliveStatus": 0,
"AgentOn": 1,
"CasbOn": 1,
"GroupId": "MyTestGroup",
"Available": "Normal",
"CdbOn": 1,
"DbPlatform": "Linux",
"DbCharset": "UTF-8",
"OsPolicy": "X86",
"BidirectionOn": 0,
"BidirectionMaxLine": 0,
"BidirectionMaxStorage": 0,
"BidirectionAllow": 0,
"BidirectionDelivery": 1,
"RoStatus": "Normal",
"AgentBound": true,
"CdbErrorMsg": ""
}
],
"CheckOn": 1,
"DeployErrorMsg": "",
"DeployMac": "52:7A:FC:8B:12:9E",
"DeployPath": "/dara/CapAgent",
"DeployStatus": 1,
"DeployType": 1,
"HeartbeatTime": 1769583553,
"Id": 1,
"JobId": 1,
"OfflineTime": 1769583553,
"ServerIp": "10.16.32.75",
"ServerPort": 3306,
"AgentCpuUsage": 0,
"AgentMemoryUsage": 0,
"MachineCpuUsage": 0,
"MachineMemoryUsage": 0,
"CanDelete": true,
"CanModify": true,
"CanStop": true,
"CanUninstall": true,
"CanStart": true,
"DbAssetsList": [
{
"AddTime": 1769583553,
"Aid": 1,
"AssetsIp": "10.16.32.75",
"AssetsName": "MyTestAssets",
"AssetsPort": 3306,
"AssetsType": "MySQL",
"AssetsVersion": "8.0",
"AssetsAddType": 1,
"Status": 1,
"UpdateTime": 1769583553,
"VpcId": "vpc-82kj124f",
"RegionId": "ap-region",
"Permission": 0,
"InstanceId": "ins-219ijks9",
"InstanceName": "MyDevInstance",
"AddType": 1,
"AssetSubnetId": "subnet-89j21jkr",
"UploadPem": 0,
"AliveStatus": 0,
"AgentOn": 1,
"CasbOn": 1,
"GroupId": "MyTestGroup",
"Available": "Normal",
"CdbOn": 1,
"DbPlatform": "Linux",
"DbCharset": "UTF-8",
"OsPolicy": "X86",
"BidirectionOn": 0,
"BidirectionMaxLine": 0,
"BidirectionMaxStorage": 0,
"BidirectionAllow": 0,
"BidirectionDelivery": 1,
"RoStatus": "Normal",
"AgentBound": true,
"CdbErrorMsg": ""
}
],
"ApiAssetsList": [
{
"AddTime": 1769583553,
"Aid": 1,
"AssetsIp": "10.16.32.75",
"AssetsName": "MyTestAssets",
"AssetsPort": 3306,
"AssetsType": "MySQL",
"AssetsVersion": "8.0",
"AssetsAddType": 1,
"Status": 1,
"UpdateTime": 1769583553,
"VpcId": "vpc-82kj124f",
"RegionId": "ap-region",
"Permission": 0,
"InstanceId": "ins-219ijks9",
"InstanceName": "MyDevInstance",
"AddType": 1,
"AssetSubnetId": "subnet-89j21jkr",
"UploadPem": 0,
"AliveStatus": 0,
"AgentOn": 1,
"CasbOn": 1,
"GroupId": "MyTestGroup",
"Available": "Normal",
"CdbOn": 1,
"DbPlatform": "Linux",
"DbCharset": "UTF-8",
"OsPolicy": "X86",
"BidirectionOn": 0,
"BidirectionMaxLine": 0,
"BidirectionMaxStorage": 0,
"BidirectionAllow": 0,
"BidirectionDelivery": 1,
"RoStatus": "Normal",
"AgentBound": true,
"CdbErrorMsg": ""
}
],
"DspaInstanceLevelApiAssetsList": [
{
"DspaInstanceId": "dspa-98iowqk",
"Authorized": true,
"Ports": [0]
}
],
"SubnetId": "subnet-89j21jkr"
}
],
"RequestId": "3303b1cf-6603-4328-8a8b-0c5669a1b098"
}
}