接口功能介绍
调用此接口可以查询一台或多台弹性云主机、物理机内是否安装了云助手agent
说明：仅支持批量查询弹性云主机或物理机是否安装了云助手agent，不支持混合查询
接口约束
无
URI
POST /v4/cloud-assistant/get-ca-agent
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 88f8888888dd88ec888888888d888d8b | |
| instanceIDs | 是 | String | 待执行命令的云主机、物理机ID列表, 使用英文 , 分割 | 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa,d8e8888-8ed8-88b8-88cb-888f8b8cf8fb | |
| pageNo | 否 | Integer | 当前页码，默认值为1 | 1 | |
| pageSize | 否 | Integer | 分页查询时设置的每页行数，最大值为100，默认为10 | 10 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800 为成功，900 为失败） | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码，详见错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Param is null | |
| description | String | 失败时的错误描述，一般为中文描述 | 请求参数错误 | |
| returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| caAgentStatusSet | Array of Objects | 状态列表 | caAgentStatusSet | |
| totalCount | Integer | 命令总个数 | 1 | |
| pageNo | Integer | 当前页码 | 1 | |
| pageSize | Integer | 每页行数 | 10 |
表 caAgentStatusSet
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| status | String | agent当前状态，取值范围： Error：异常； Running：运行中； |
Running | |
| agentName | String | agent名称 | ca-agent-cloud-assistant | |
| version | String | 版本 | v1.0.0 | |
| instanceID | String | 实例ID | 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"instanceIDs": "8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa,8d8e8888-8ed8-88b8-88cb-888f8b8cf8fb",
"pageNo": 1,
"pageSize": 10
}
响应示例
{
"returnObj":
{
"caAgentStatusSet": [
{
"status": "Running",
"agentName": "ca-agent-cloud-assistant",
"version": "1.0.1",
"instanceID": "8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa"
}
],
"totalCount": 1,
"pageNo": 1,
"pageSize": 10
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
