CreateCommand

接口说明

• 您可以创建以下类型的命令：
  • Windows实例适用的Bat脚本（RunBatScript）
  • Windows实例适用的PowerShell脚本（RunPowerShellScript）
  • Linux实例适用的Shell脚本（RunShellScript）
• 您可以通过指定参数TimeOut为命令设置在ECS实例中执行时最大的超时时间，命令执行超时后，云助手客户端会强制终止命令进程，即取消命令的PID。
  • 对于单次执行，超时后，该命令针对指定的ECS实例的执行状态（InvokeRecordStatus)变为执行失败（Failed）。
  • 对于周期执行：
    • 周期执行的超时时间对每一次执行记录均有效。
    • 某次执行超时后，该次执行记录的状态（InvokeRecordStatus）变为执行失败（Failed）。
    • 上次执行超时与否不影响下一次执行。
• 在一个地域下，您最多可以保有100条云助手命令。您也可以提交工单调整保有量配额。
• 您可以通过指定参数WorkingDir为命令指定执行路径。对于Linux实例，默认在管理员root用户的home目录下，具体为/root目录。对于Windows实例，默认在云助手客户端进程所在目录，例如，C:\ProgramData\aliyun\assist\$(version)。
• 您可以通过指定参数EnableParameter=true启用自定义参数功能。在设置CommandContent时可以通过{{$(parameter)}}的形式表示自定义参数，并在运行命令（InvokeCommand）时，传入自定义参数键值对。例如，您在创建命令时，创建了echo {{name}}命令，在 InvokeCommand时，通过Parameter参数传入键值对<name, Jack>。则自定义参数将自动替换命令，您会得到一条新的命令，并在实例中执行echo Jack。

请求参数

返回数据

示例

请求示例

https://ecs.aliyuncs.com/?Action=CreateCommand
&CommandContent=ZWNobyB7e25hbWV9fSA=
&Name=Test
&RegionId=cn-hangzhou
&Type=RunShellScript
&Description=Test1
&WorkingDir=/home/
&Timeout=3600
&EnableParameter=true
&<公共请求参数>

正常返回示例

XML 格式

<CreateCommandResponse>
      <RequestId>E69EF3CC-94CD-42E7-8926-F133B86387C0</RequestId>
      <CommandId>c-7d2a745b412b4601b2d47f6a768d3***</CommandId>
</CreateCommandResponse>

JSON 格式

{
	"RequestId":"E69EF3CC-94CD-42E7-8926-F133B86387C0",
	"CommandId":"c-7d2a745b412b4601b2d47f6a768d3***"
}

错误码

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