Elastic Compute Service:CreateCommand

The region ID. You can call DescribeRegions to query the most recent region list.

The command name. All character sets are supported. The name cannot exceed 128 characters in length.

The command description. All character sets are supported. The description cannot exceed 512 characters in length.

The type of the command. Valid values:

• RunBatScript: creates a Bat script to run on Windows instances.

• RunPowerShellScript: creates a PowerShell script to run on Windows instances.

• RunShellScript: creates a Shell script to run on Linux instances.

The Base64-encoded content of the command.

• The value of this parameter must be Base64-encoded, and the script content cannot exceed 18 KB in size after Base64 encoding.

• The command content supports custom parameters. To enable the custom parameter feature, set EnableParameter=true:

  • Custom parameters are defined by enclosing them in {{}}. Spaces and line breaks before and after the parameter name within {{}} are ignored.

  • The number of custom parameters cannot exceed 20.

  • Custom parameter names can contain letters (a-z, A-Z), digits (0-9), hyphens (-), and underscores (_). The acs:: prefix for specifying non-built-in environment parameters is not supported. Other characters are not supported. Parameter names are case-insensitive.

  • Each parameter name cannot exceed 64 bytes in length.

• You can specify built-in environment parameters as custom parameters. When the command is run, Cloud Assistant automatically replaces them with the corresponding values from the environment without requiring manual assignment. The following built-in environment parameters are supported:

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

  • {{ACS::AccountId}}: the UID of the Alibaba Cloud account.

  • {{ACS::InstanceId}}: the instance ID. When a command is sent to multiple instances and you want to use {{ACS::InstanceId}} as a built-in environment parameter, make sure that the Cloud Assistant Agent version is not earlier than:

    • Linux: 2.2.3.309

    • Windows: 2.1.3.309

  • {{ACS::InstanceName}}: the instance name. When a command is sent to multiple instances and you want to use {{ACS::InstanceName}} as a built-in environment parameter, make sure that the Cloud Assistant Agent version is not earlier than:

    • Linux: 2.2.3.344

    • Windows: 2.1.3.344

  • {{ACS::InvokeId}}: the command execution ID. To use {{ACS::InvokeId}} as a built-in environment parameter, make sure that the Cloud Assistant Agent version is not earlier than:

    • Linux: 2.2.3.309

    • Windows: 2.1.3.309

  • {{ACS::CommandId}}: the command ID. When you run a command by calling the RunCommand operation and want to use {{ACS::CommandId}} as a built-in environment parameter, make sure that the Cloud Assistant Agent version is not earlier than:

    • Linux: 2.2.3.309

    • Windows: 2.1.3.309.

The directory where the command is run on the ECS instance. The value cannot exceed 200 characters in length.

Default value:

• Linux instances: the home directory of the root user, which is /root.

• Windows instances: the directory where the Cloud Assistant Agent process is located, such as C:\Windows\System32.

The maximum timeout period for the command to run on the ECS instance. Unit: seconds. If the command cannot be run for any reason, a timeout occurs. After the timeout, the command process is forcefully terminated by canceling the PID of the command.

Default value: 60.

Specifies whether the command uses custom parameters.

Default value: false.

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

• PlainText: no encoding. The content is transmitted in plaintext.

• Base64: Base64 encoding.

Default value: Base64.

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that the token is unique among different requests. ClientToken supports only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

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

The bootstrap program for script execution. The value cannot exceed 1 KB in length.

The list of tags.