接口功能介绍
支持用户批量执行升级/安装、启动、停止、卸载监控插件操作
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
接口约束
1. 云主机处于开机状态
2. 使用限制，本接口目前只支持update操作
URI
POST /v4/ecs/agent/batch-action
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
| action | 是 | String | 执行的动作，可执行的动作有 update: 升级或安装， start: 启动， stop: 停止， remove: 卸载 |
||
| actionInfo | 是 | Array of Objects | 云主机操作信息 | actionInfo |
表 actionInfo
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| instanceID | 是 | String | 云主机ID，您可以查看弹性云主机了解云主机的相关信息 获取： 查 查询云主机列表 创 创建一台按量付费或包年包月的云主机 创 批量创建按量付费或包年包月云主机 |
88f888ea-88ff-88ec-a8bc-888888888fe8 | |
| systemType | 是 | String | 云主机的系统类型,有linux和windows | ||
| systemArch | 否 | String | 云主机的CPU架构,CPU架构有 amd64: AMD64、x86-64、x64， arm64: ARM64、AARCH64 |
||
| systemVersion | 否 | String | 云主机系统版本 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| error | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| message | String | 失败或成功时的描述，一般为英文描述 | Success | |
| description | String | 失败或成功时的描述，一般为中文描述 | 成功 | |
| returnObj | Object | 返回参数，参考表returnObj | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| results | Array of Objects | 分页明细 | results |
表 results
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| instanceID | String | 云主机ID | 0e4ac7c5-ba0e-42ff-af23-c7043f3c7783 | |
| status | Integer | qga命令执行状态，执行状态有 -1: 调用云助手失败，未执行命令， 0: 命令执行成功，有返回值， 1: 命令执行成功，无返回值， 2: 命令执行失败，有返回值， 3: 命令执行失败，无返回值， 4: 命令执行超时，需通过查询命令执行结果接口异步查询 |
0 | |
| result | String | 具体信息 | ||
| pid | Integer | 执行命令的进程ID | 9868 | |
| code | Integer | 业务状态码 | 200 | |
| msg | String | 提示信息 | success |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"action": "update",
"actionInfo": [{
"instanceId": "0e4ac7c5-ba0e-42ff-af23-c7043f3c7783",
"systemType": "linux",
"systemArch": "amd64",
"systemVersion": "1.27.6"
}, {
"instanceId": "d48a4d56-ec2f-804c-2e1b-8454d468124g",
"systemType": "linux",
"systemArch": "amd64",
"systemVersion": "1.27.6"
}]
}
响应示例
{
"returnObj": {
"results": [{
"instanceID": "0e4ac7c5-ba0e-42ff-af23-c7043f3c7783",
"status": 0,
"result": "[Execute guest command: curl -o update_agent.sh http://10.63.172.130:80/cttg/linux/update_agent.sh successfully,Execute guest command: chmod +x update_agent.sh successfully,SHELL_FOLDER = /\nurl = http://10.63.172.130:80\nmode = 1\nbucketPath = cttg\nsecondPath = linux\nbinFile = telegraf\nconfFile = telegraf.conf\ntimeout = 30\narch = amd64\ninit_method = systemd\nserviceFile = telegraf.service\ndownload files start...\ndownloading... path: http://10.63.172.130:80/cttg/linux/amd64/telegraf file: telegraf\ndownloading... path: http://10.63.172.130:80/cttg/linux/telegraf.conf file: telegraf.conf\ndownloading... path: http://10.63.172.130:80/cttg/linux/telegraf.service file: telegraf.service\ndownload files finished!\nuninstall telegraf start...\nuninstall telegraf finished!\ninstall telegraf start...\ninstall telegraf finished!\nstop and rename zabbix start...\nstop and rename zabbix finished!\neverthing is OK!\n]",
"pid": 9868,
"code": 200,
"msg": "success"
}, {
"instanceID": "d48a4d56-ec2f-804c-2e1b-8454d46812ga",
"status": 2,
"result": "timeout",
"pid": 7546,
"code": 200,
"msg": "success"
}]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
