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