在轻量应用服务器上执行命令。
接口说明
命令助手是专为轻量应用服务器打造的自动化运维工具。您无需登录,即可在控制台上通过命令(Shell、Powershell 和 Bat)对轻量应用服务器实例进行运维管理操作。
使用命令助手时,需满足以下条件:
轻量应用服务器实例的状态必须为运行中。
已安装云助手客户端。轻量应用服务器实例默认已安装云助手客户端,如果您手动卸载,需重新安装。具体操作,请参见安装云助手客户端。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
swas-open:RunCommand |
create |
*Command
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| CommandContent |
string |
是 |
命令内容。您需要注意:
|
ifconfig -s |
| WorkingDir |
string |
否 |
您可自定义命令的执行路径。默认路径如下:
|
/root |
| RegionId |
string |
是 |
地域 ID。您可以调用 ListRegions 查看最新的阿里云地域列表。 |
cn-hangzhou |
| Timeout |
integer |
否 |
设置命令在服务器实例中的超时时间,单位为秒。 当执行命令的任务超时后,命令助手将强制终止任务进程。可设定超时时间取值范围为 10~86400 秒(24 小时)。 默认值:60。 |
60 |
| Type |
string |
是 |
命令的语言类型。取值范围:
|
RunShellScript |
| EnableParameter |
boolean |
否 |
命令中是否包含自定义参数。 默认值:false。 |
false |
| Parameters |
object |
否 |
命令中包含自定义参数时,执行命令时传入的自定义参数的键值对。例如,命令内容为 自定义参数的个数范围为 0~20,且您需要注意:
默认值为空,表示取消设置该参数从而禁用自定义参数。 |
{"name":"Jack", "accessKey":"LTAI****************"} |
| WorkingUser |
string |
否 |
您可以指定以某个轻量应用服务器实例中存在的用户执行命令,建议使用普通用户执行命令可降低安全风险。 默认值:
|
root |
| WindowsPasswordName |
string |
否 |
Windows 实例中执行命令的用户的密码名称。 当您希望以非默认用户(System)在 Windows 实例中执行命令时,需要同时传入 WorkingUser 和该参数。为降低密码泄露的风险,需要将密码明文托管在运维编排服务的参数仓库中,此处仅传入密码的名称。 |
axtSecretPassword |
| InstanceId |
string |
是 |
轻量应用云服务器实例 ID。 |
ace0706b2ac4454d984295a94213**** |
| Name |
string |
是 |
执行命令名称。 |
testName |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
| InvokeId |
string |
命令执行 ID。 |
t-hz02p9545t6**** |
示例
正常返回示例
JSON格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"InvokeId": "t-hz02p9545t6****"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。