1. 接口描述
接口请求域名： cds.api3.fincloud.tencent.cn。
查询Agent部署列表
默认接口请求频率限制：20次/秒。
接口更新时间：2024-05-17 17:41:01。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeAgentDeploy |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-04-20 |
| Region | 是 | 否 | String | 公共参数，地域信息本接口不需要传递此参数。 |
| Limit | 否 | 否 | Int64 | 限制数目 示例值： 1 |
| Offset | 否 | 否 | Int64 | 偏移量 示例值： 10 |
| SystemType | 否 | 否 | Int64 | 操作系统(-1 全部，0 linux，1 windows) 示例值： 1 |
| AgentStatus | 否 | 否 | Int64 | Agent状态 （0 已离线，1 运行中，2 过载停止，3 手动停止，4 已卸载，5 未部署，6 部署中，8 卸载中，9 卸载失败） 示例值： 1 |
| AutoAssistant | 否 | 否 | Int64 | 自动化助手（-1 全部 ，0 离线，1 在线，2 未安装） 示例值： 1 |
| RegionId | 是 | 否 | String | 地域 示例值： region1 |
| VpcId | 是 | 否 | String | VPC 示例值： vpc-osmndkx5 |
| SearchValues | 否 | 否 | Array of NameValueString | CVM IP/名称 搜索 示例值：查看 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Uint64 | 总数目 示例值： 10 |
| List | Array of AgentDeployInfo | Agent部署列表信息 示例值：查看 |
| VpcAccessStatus | Uint64 | 是否打通VPC 示例值： 1 |
| JobStatus | Int64 | 0: 任务未执行 1 任务执行中 示例值： 0 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。