CreateCommand

Description

• You can create commands of the following types:
  • RunBatScript: batch commands, applicable to Windows instances
  • RunPowerShellScript: PowerShell commands, applicable to Windows instances
  • RunShellScript: shell commands, applicable to Linux instances
• You can specify the TimeOut parameter to set the maximum timeout period for command executions on Elastic Compute Service (ECS) instances. When a command execution times out, the Cloud Assistant client forcefully terminates the execution by canceling the process ID (PID) of the command. For more information, see Install the Cloud Assistant client.
  • One-time execution: After an execution times out, the state of the execution (InvokeRecordStatus) on specific instances becomes Failed.
  • Recurring execution:
    • The timeout period takes effect on each execution.
    • After an execution times out, the state of the execution (InvokeRecordStatus) becomes Failed.
    • The timeout of each execution does not affect the next execution.
• Within each region, you can retain a maximum of 100 Cloud Assistant commands. You can also submit a ticket to increase the command quota.
• You can use the WorkingDir parameter to specify the working directory of a Cloud Assistant command. For Linux instances, the default working directory of a command is the home directory of the root user, which is /root. For Windows instances, the default working directory of a command is the directory where the Cloud Assistant client process resides, such as C:\Windows\System32.
• You can enable the custom parameter feature for a Cloud Assistant command by setting EnableParameter to true when you create the command. When you set the CommandContent parameter, you can define custom parameters in the {{parameter}} format. Then, when the InvokeCommand operation is called, the key-value pairs of custom parameters can be passed in. For example, if a command content is echo {{name}}, the Parameters parameter can be used to pass in the <name, Jack> key-value pair when the InvokeCommand operation is called. The name key of the custom parameter is automatically replaced by the paired Jack value to generate a new command. As a result, the echo Jack command is actually run.

Request parameters

Response parameters

Examples

Sample requests

https://ecs.aliyuncs.com/?Action=CreateCommand
&CommandContent=ZWNobyB7e25hbWV9fSA=
&Name=testName
&RegionId=cn-hangzhou
&Type=RunShellScript
&Description=testDescription
&WorkingDir=/root/
&Timeout=60
&EnableParameter=true
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, visit the API Error Center.