接口功能介绍
调用此接口为一台或多台弹性云主机或物理机触发一条云助手命令
说明：仅支持批量为弹性云主机或物理机触发云助手命令，不支持混合触发
接口约束
1.弹性云主机、物理机必须处于运行状态
2.弹性云主机、物理机中必须安装天翼云云助手且服务处于运行状态
URI
POST /v4/cloud-assistant/invoke-command
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 88f8888888dd88ec888888888d888d8b | |
| instanceIDs | 是 | String | 待执行命令的云主机、物理机ID列表, 使用英文, 分割 | 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa,d8e8888-8ed8-88b8-88cb-888f8b8cf8fb | |
| commandID | 是 | String | 命令ID | a6a08d82-2f89-11ee-a2b7-774dd7c6ebaf | |
| timeout | 否 | Integer | 执行命令的超时时间 | 60 | |
| workingDirectory | 否 | String | 命令在云主机中运行目录。说明：若在Windows系统云主机下执行Python命令，需传Python安装全路径 | /root | |
| parameter | 否 | Map of String | 自定义参数，说明：key仅支持大小写字母(A-a)、数字(0-9)、横线(-)和下划线(_)，key和value均只支持string |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800 为成功，900 为失败） | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码，详见错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Param is null | |
| description | String | 失败时的错误描述，一般为中文描述 | 请求参数错误 | |
| returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| invokedID | String | 命令执行ID | a6a08d82-2f89-11ee-a2b7-774dd7c6ebaf |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"instanceIDs": "8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa,d8e8888-8ed8-88b8-88cb-888f8b8cf8fb",
"commandID": "a6a08d82-2f89-11ee-a2b7-774dd7c6ebaf",
"timeout": 180,
"parameter": {"userid": "11111111"}
}
响应示例
{
"returnObj": {
"invokedID": "a6a08d82-2f89-11ee-a2b7-774dd7c6ebaf"
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
