文档

RunCommand - 执行命令

更新时间:

在轻量应用服务器上执行命令。

接口说明

命令助手是专为轻量应用服务器打造的自动化运维工具。您无需登录,即可在控制台上通过命令(Shell、Powershell 和 Bat)对轻量应用服务器实例进行运维管理操作。

使用命令助手时,需满足以下条件:

  • 轻量应用服务器实例的状态必须为运行中。
  • 已安装云助手客户端。轻量应用服务器实例默认已安装云助手客户端,如果您手动卸载,需重新安装。具体操作,请参见安装云助手客户端

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
swas-open:RunCommandWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
CommandContentstring

命令内容。您需要注意:

  • 指定参数EnableParameter=true可在命令内容中启用自定义参数功能:
  • 用{{}}包含的方式定义自定义参数,在{{}}内参数名前后的空格以及换行符会被忽略。
  • 自定义参数个数不能超过 20 个。
  • 自定义参数名允许 a-zA-Z0-9-_的组合,不支持其余字符,参数名不区分大小写。
  • 单个自定义参数名不能超过 64 字节。
ifconfig -s
WorkingDirstring

您可自定义命令的执行路径。默认路径如下:

  • Linux 实例:执行路径默认在管理员 root 用户的/root 目录下。
  • Windows 实例:执行路径默认在 C:\Windows\system32 目录下。
/root
RegionIdstring

地域 ID。您可以调用 ListRegions 查看最新的阿里云地域列表。

cn-hangzhou
Timeoutinteger

设置命令在服务器实例中的超时时间,单位为秒。

当执行命令的任务超时后,命令助手将强制终止任务进程。可设定超时时间取值范围为 10~86400 秒(24 小时)。

默认值:60。

60
Typestring

命令的语言类型。取值范围:

  • RunBatScript:适用于 Windows 实例的 Bat 命令。
  • RunPowerShellScript:适用于 Windows 实例的 PowerShell 命令。
  • RunShellScript:适用于 Linux 实例 Shell 命令。
RunShellScript
EnableParameterboolean

命令中是否包含自定义参数。

默认值:false。

false
Parametersobject

命令中包含自定义参数时,执行命令时传入的自定义参数的键值对。例如,命令内容为echo {{name}},则可以通过Parameters参数传入键值对{"name":"Jack"}。自定义参数将自动替换变量值name,得到一条新的命令,实际执行的是echo Jack

自定义参数的个数范围为 0~20,且您需要注意:

  • 键不允许为空字符串,最多支持 64 个字符。
  • 值允许为空字符串。
  • 自定义参数与原始命令内容在 Base64 编码后,综合长度不能超过 16 KB。
  • 设置的自定义参数名集合必须为创建命令时定义的参数集的子集。对于未传入的参数,您可以使用空字符串代替。

默认值为空,表示取消设置该参数从而禁用自定义参数。

{"name":"Jack", "accessKey":"LTAIdyvdIqaRY****"}
WorkingUserstring

您可以指定以某个轻量应用服务器实例中存在的用户执行命令,建议使用普通用户执行命令可降低安全风险。 默认值:

  • root:Linux 实例中默认以 root 用户执行命令。

  • system:Windows 实例中默认以 system 用户执行命令。

root
WindowsPasswordNamestring

Windows 实例中执行命令的用户的密码名称。

当您希望以非默认用户(System)在 Windows 实例中执行命令时,需要同时传入 WorkingUser 和该参数。为降低密码泄露的风险,需要将密码明文托管在运维编排服务的参数仓库中,此处仅传入密码的名称。

axtSecretPassword
InstanceIdstring

轻量应用云服务器实例 ID。

ace0706b2ac4454d984295a94213****
Namestring

执行命令名称。

testName

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
InvokeIdstring

命令执行 ID。

t-hz02p9545t6****

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "InvokeId": "t-hz02p9545t6****"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)