为一台或多台轻量应用服务器执行一条命令助手命令。
接口说明
- 对目标轻量应用服务器有如下限制,当您选择多台轻量应用服务器后,若其中某台轻量应用服务器不满足执行条件,需要重新调用该接口。
服务器状态必须为运行中(
Running),您可以调用 ListInstances 查询。已预先安装云助手 Agent。
执行类型为 PowerShell 的命令时,必须已经配置了 PowerShell 模块。
命令可能会因为目标服务器的状态异常,网络异常或云助手 Agent 异常而出现无法执行的情况,无法执行不会生成执行信息。
当您创建命令启用了自定义参数时,需要在执行命令时传入自定义参数(
Parameters)。调用此接口时您只能选择一条公共命令或您创建的自定义命令。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
swas-open:InvokeCommand |
none |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
地域 ID。您可以调用 ListRegions 查询可用地域。 |
cn-hangzhou |
| CommandId |
string |
是 |
命令 ID。您可以通过接口 DescribeCommands 查询所有可用的 CommandId。 |
c-sh02yh0932w**** |
| Parameters |
object |
否 |
启用自定义参数功能时,执行命令时传入的自定义参数的键值对。
|
{"delayed_insert_timeout":"600","max_length_for_sort_data":"2048"} |
| Username |
string |
否 |
在轻量应用服务器中执行命令的用户名称。长度不得超过 255 个字符。
您可以修改 Linux 系统执行用户,Windows 系统执行用户不支持修改。 |
test |
| InstanceIds |
string |
是 |
轻量应用服务器的实例 ID。取值可以由多个实例 ID 组成一个 JSON 数组,最多支持 50 个 ID,ID 之间用半角逗号(,)隔开。 |
["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"] |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
20758A-585D-4A41-A9B2-28DA8F4F**** |
| InvokeId |
string |
命令执行 ID。 |
t-bj02prjhw1n**** |
示例
正常返回示例
JSON格式
{
"RequestId": "20758A-585D-4A41-A9B2-28DA8F4F****",
"InvokeId": "t-bj02prjhw1n****"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。