All Products
Search
Document Center

Elastic Compute Service:CreateCommand

Last Updated:Mar 13, 2024

Creates a Cloud Assistant command.

Operation description

  • You can create commands of the following types:

    • RunBatScript: batch commands. These commands are applicable to Windows instances.
    • RunPowerShellScript: PowerShell commands. These commands are applicable to Windows instances.
    • RunShellScript: shell commands. These commands are applicable to Linux instances.
  • You can specify the TimeOut parameter to set the maximum timeout period for executions of a command on Elastic Compute Service (ECS) instances. If an execution times out, the Cloud Assistant client forcefully terminates the command process by canceling the process ID (PID) of the command. For more information, see Install the Cloud Assistant client.

    • When the one-time execution of a command times out, the execution state ( InvokeRecordStatus ) of the command becomes Failed.

    • For a scheduled task, take note of the following items:

      • The timeout period takes effect on each execution of the command.
      • When a scheduled execution of a command times out, the execution state ( InvokeRecordStatus ) of the command becomes Failed.
      • The timeout of one execution does not affect the subsequent executions of the command.
  • You can retain up to 500 to 10,000 Cloud Assistant commands in each region.

  • You can use the WorkingDir parameter to specify the execution directory of a Cloud Assistant command. For Linux instances, the default execution directory of a command is the home directory of the root user, which is /root. For Windows instances, the default execution 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 configure 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 are passed in. For example, assume that the command content is echo {{name}}. You can use the Parameters parameter 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. Therefore, the echo Jack command is actually run.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region in which to create the command. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
NamestringYes

The name of the command. The name supports all character sets and can be up to 128 characters in length.

testName
DescriptionstringNo

The description of the command. The description supports all character sets and can be up to 512 characters in length.

testDescription
TypestringYes

The command type. Valid values:

  • RunBatScript: batch commands. These commands are applicable to Windows instances.
  • RunPowerShellScript: PowerShell commands. These commands are applicable to Windows instances.
  • RunShellScript: shell commands. These commands are applicable to Linux instances.
RunShellScript
CommandContentstringYes

The Base64-encoded content of the command.

  • The parameter value must be Base64-encoded and cannot exceed 18 KB in size.

  • Custom parameters can be added to the command. To enable the custom parameter feature, you must set EnableParameter to true.

    • Custom parameters are defined in the {{}} format. Within {{}}, the spaces and line feeds before and after the parameter names are ignored.
    • The number of custom parameters cannot exceed 20.
    • A custom parameter name can contain only letters, digits, underscores (_), and hyphens (-). The name is case-insensitive.
    • Each custom parameter name cannot exceed 64 bytes in length.
  • You can specify built-in environment parameters as custom parameters. Then, when you run the command, these parameters are automatically specified by Cloud Assistant. You can specify the following built-in environment parameters:

    • {{ACS::RegionId}}: the region ID.

    • {{ACS::AccountId}}: the instance ID.

    • {{ACS::InstanceId}}: the ID of the instance. When the command is run on multiple instances, if you want to specify {{ACS::InstanceId}} as a built-in environment variable, make sure that the version of the Cloud Assistant client is not earlier than the following ones:

      • Linux: 2.2.3.309
      • Windows: 2.1.3.309
    • {{ACS::InstanceName}}: the instance name. If you want to run the command on multiple instances and specify {{ACS::InstanceName}} as a built-in environment parameter, make sure that the version of the Cloud Assistant client is not earlier than the following ones:

      • Linux: 2.2.3.344
      • Windows: 2.1.3.344
    • {{ACS::InvokeId}}: the task ID. If you want to specify {{ACS::InvokeId}} as a built-in environment variable, make sure that the version of the Cloud Assistant client is not earlier than the following one:

      • Linux: 2.2.3.309
      • Windows: 2.1.3.309
    • {{ACS::CommandId}}: the ID of the command. When you call the RunCommand operation, if you want to specify {{ACS::CommandId}} as a built-in environment parameter, make sure that the version of the Cloud Assistant client is not earlier than the following ones:

      • Linux: 2.2.3.309
      • Windows: 2.1.3.309
ZWNobyAxMjM=
WorkingDirstringNo

The working directory of the command on the instance.

Default value:

  • For Linux instances, the default value is the home directory of the root user, which is the /root directory.
  • For Windows instances, the default value is the directory where the Cloud Assistant client process resides. Example: C:\Windows\System32\.
/root/
TimeoutlongNo

he maximum timeout period for the command execution on the instance. Unit: seconds. When a command that you created cannot be run, the command times out. When a command execution times out, Cloud Assistant Agent forcefully terminates the command process by canceling the PID.

Default value: 60.

60
EnableParameterbooleanNo

Specifies whether to use custom parameters in the command.

Default value: false.

false
ContentEncodingstringNo

The encoding mode of the command content (CommandContent). Valid values:

  • PlainText: The command content is not encoded.
  • Base64: The command content is Base64-encoded.

Default value: Base64.

Note If the specified value of this parameter is invalid, Base64 is used by default.
PlainText
ResourceGroupIdstringNo

The ID of the resource group to which to assign the command.

rg-123******
Tagobject []No

The tags to add to the command.

KeystringNo

The key of tag N. Valid values of N: 1 to 20. The tag key cannot be an empty string.

If a single tag is specified to query resources, up to 1,000 resources that have this tag added can be displayed in the response. If multiple tags are specified to query resources, up to 1,000 resources that have all these tags added can be displayed in the response. To query more than 1,000 resources that have specified tags, call ListTagResources operation.

The tag key can be up to 64 characters in length and cannot start with acs: or aliyun. It cannot contain http:// or https://.

TestKey
ValuestringNo

The value of tag N. Valid values of N: 1 to 20. The tag value can be an empty string.

It can be up to 128 characters in length and cannot contain http:// or https://.

TestValue

Response parameters

ParameterTypeDescriptionExample
object
CommandIdstring

The ID of the command.

c-7d2a745b412b4601b2d47f6a768d****
RequestIdstring

The ID of the request.

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

Examples

Sample success responses

JSONformat

{
  "CommandId": "c-7d2a745b412b4601b2d47f6a768d****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

Error codes

HTTP status codeError codeError messageDescription
400RegionId.ApiNotSupportedThe api is not supported in this region.The API operation cannot be called in the specified region. Check whether the specified RegionId parameter is valid.
400CmdParam.EmptyKeyYou must specify the parameter names.Some required parameters are not specified.
400CmdParam.InvalidParamNameInvalid parameter name. The name can contain only lowercase letters (a to z), uppercase letters (A to Z), numbers (0 to 9), hyphens (-), and underscores (_).The custom parameter name is invalid. A custom parameter name can contain only letters, digits, underscores (_), and hyphens (-).
400CmdContent.DecodeErrorThe CommandContent can not be base64 decoded.-
400InvalidParameter.WorkingDirThe specified parameter WorkingDir is not valid.-
403CmdContent.ExceedLimitThe length of the command content exceeds the upper limit.The length of command content exceeds the upper limit.
403CmdName.ExceedLimitThe length of the command name exceeds the upper limit.The length of the command name exceeds the upper limit.
403CmdDesc.ExceedLimitThe length of the command description exceeds the upper limit.The length of the command description exceeds the upper limit.
403CmdCount.ExceedQuotaThe total number of commands in the current region exceeds the quota.The maximum number of Cloud Assistant commands in the current region has been exceeded.
403CmdParamCount.ExceedLimitThe maximum number of custom parameters is exceeded.The number of specified parameters exceeds the upper limit.
403CmdParamName.ExceedLimitThe maximum length of a parameter name is exceeded.The length of the custom parameter name exceeds the upper limit.
403Operation.ForbiddenThe operation is not permitted.The operation is not supported.
403InvalidStatus.ResourceGroupYou cannot perform an operation on a resource group that is being created or deleted.Operation not allowed while resource group is being created or deleted.
404InvalidCmdType.NotFoundThe specified command type does not exist.-
404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.The RegionId provided does not exist
404InvalidResourceGroup.NotFoundThe ResourceGroup provided does not exist in our records.The specified resource group does not exist.
500InternalError.DispatchAn error occurred when you dispatched the request.An error occurred while the request is being sent. Try again later.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-10-24The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 403 change
    Error Codes 404 change
    delete Error Codes: 400
    delete Error Codes: 500
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ResourceGroupId
2023-05-12The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    Error Codes 403 change
    Error Codes 404 change
    delete Error Codes: 500
2022-02-25The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 403 change
    Error Codes 404 change
    delete Error Codes: 400
    delete Error Codes: 500