接口功能介绍
调用此接口在一台或多台弹性云主机或物理机中执行一段Shell、PowerShell、Bat或Python类型的脚本命令
接口约束
1.弹性云主机、物理机必须处于运行状态；
2.弹性云主机、物理机中必须安装天翼云云助手且服务处于运行状态；
URI
POST /v4/cloud-assistant/run-command
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 88f8888888dd88ec888888888d888d8b | |
| instanceIDs | 是 | String | 待执行命令的弹性云主机、物理机ID列表, 使用英文 , 分割（当前仅支持同时下发弹性云主机ID或同时下发物理机ID，不支持混合下发） | 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa,d8e8888-8ed8-88b8-88cb-888f8b8cf8fb | |
| commandName | 否 | String | 命令名称，长度不超过128个字符 | testName | |
| description | 否 | String | 命令描述，长度不超过512个字符 | testDescription | |
| commandType | 是 | String | 命令类型，取值范围： Shell：适用于Linux云主机、物理机的Shell命令； Bat：适用于Windows云主机的Bat命令； PowerShell：适用于Windows云主机的PowerShell命令； Python：适用于Python命令。 说明：当前物理机云助手还不支持windows系统。 |
Shell | |
| commandContent | 是 | String | 加密后的命令内容，长度不可超过24KB | ||
| workingDirectory | 否 | String | 命令在实例中运行目录： Linux系统默认路径为 /tmp; Windows系统默认路径为 C:\Windows\System32。 说明：若在Windows系统云主机下执行Python命令，需要传Python安装全路径。 |
/home/user | |
| timeout | 否 | Integer | 命令超时时间。默认值60秒 | 60 | |
| saveCommand | 否 | Boolean | 是否保存命令，默认false | true | |
| enabledParameter | 否 | Boolean | 是否启用自定义参数，默认值为false，若传true，则必须传defaultParameter，若enabledParameter为false，则defaultParameter和parameter都不能传 | false | |
| defaultParameter | 否 | Array of Objects | 启用自定义参数功能时，自定义参数的默认取值，json 格式map数组，说明：key仅支持大小写字母(A-a)、数字(0-9)、横线(-)和下划线(_) | param | |
| parameter | 否 | Map of String | 自定义参数，说明：key仅支持大小写字母(A-a)、数字(0-9)、横线(-)和下划线(_)，key和value均只支持string | {userid: 11111111} |
表 param
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| key | 否 | String | 参数名 | userid | |
| description | 否 | String | 参数描述 | 用户id | |
| value | 否 | String | 参数值 | test |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800 为成功，900 为失败） | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码，详见错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Param is null | |
| description | String | 失败时的错误描述，一般为中文描述 | 请求参数为空 | |
| returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| commandID | String | 命令ID | ||
| 说明：saveCommand参数传false时不会生成commandID | a6a08d82-2f89-11ee-a2b7-774dd7c6ebaf | |||
| invokedID | String | 命令执行ID | a6a08d82-2f89-11ee-a2b7-774dd7c6ebaf |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "200000003335",
"instanceIDs": "b29d96af-1ab8-378e-a07c-98e7675473f6",
"commandName": "test-0221-5",
"description": "testDescription",
"commandType": "shell",
"commandContent": "gAAAAABnt1wIu5syz0Kp4KP4BU8qoU-F5XDAwMIB12ejNfPIoq2cOqR5v8Ll4kjCQpQETocRRhu4lJanVv_7BrZQZ74uWkEecdcmiIj8LMn7xtT8PUDU2g0uf3rgbZeMjH3j2tymuLMt",
"saveCommand": false,
"workingDirectory": "/tmp",
"timeout": 30,
"enabledParameter": true,
"defaultParameter": [
{
"value": "test",
"description": "参数1",
"key": "param-1"
}
]
}
响应示例
{
"returnObj": {
"commandID": "a6a08d82-2f89-11ee-a2b7-774dd7c6ebaf",
"invokedID": "a6a08d82-2f89-11ee-a2b7-774dd7c6ebaf"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
