RunCommand

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

The IDs of the ECS instances. Valid values of N: 1 to 50.

If multiple instances are specified and one of them does not meet the execution conditions, you must re-specify the IDs of all the instances.

The name of the script, which supports all character sets. It can be up to 128 characters in length.

The language type of the O&M script. Valid values:

• RunBatScript: batch scripts for Windows instances
• RunPowerShellScript: PowerShell scripts for Windows instances
• RunShellScript: shell scripts for Linux instances

The plaintext content or the Base64-encoded content of the script. The Base64-encoded script content cannot exceed 16 KB.

You can enable the custom parameter function by setting EnableParameter=true in the script content:

• Define custom parameters in the {{}} format. Within {{}}, the spaces and line breaks before and after the name of the parameter are ignored.
• The number of custom parameters cannot exceed 20.
• A custom parameter name can contain only letters, digits, underscores (_), and hyphens (-). It is case insensitive.
• Each custom parameter key cannot exceed 64 bytes.

The operation that you want to perform. Set the value to RunCommand.

The encoding mode of script content (CommandContent). Valid values (case insensitive):

• PlainText: The script content is not encoded, and transmitted in plaintext.
• Base64: base64-encoded.

Default value: PlainText. If the specified value of this parameter is invalid, PlainText is used by default.

The description of the script, which supports all character sets. It can be up to 512 characters in length.

The timeout period for script execution. Unit: seconds. A timeout error occurs when a script cannot be run because the process slows down, a specific module or the Cloud Assistant client does not exist. When the script times out, the script process is forcibly terminated.

Default value: 3600.

The running directory of the script in the ECS instance.

Default value:

• Linux instances: under the home directory of the administrator (root user): /root.
• Windows instances: under the directory where the process of the Cloud Assistant client is located, such as C:\ProgramData\aliyun\assist\$(version).

Specifies whether to periodically run the script. Valid values:

• true: runs the script on a regular basis based on the value set for the Frequency parameter. The result of the previous execution task does not affect the next execution task.
• false: runs once only.

Default value: false

The execution period of recurring tasks. If the Timed parameter is set to True, you must specify the Frequency parameter. The interval between two recurring tasks cannot be less than 10 seconds.

The parameter value follows the cron expression. For more information, see Configure scheduled commands.

Specifies whether the script contains custom parameters.

Default value: false

The key-value pairs of custom parameters passed in when the script contains custom parameters. For example, if the script content is echo {{name}}, the Parameters parameter can be used to pass in the {"name":"Jack"} key-value pair. The variable name of the custom parameter is automatically replaced to generate a new script. Therefore, echo Jack is actually run.

Number of custom parameters: 0 to 10.

• The key cannot be an empty string. It can be up to 64 characters in length.
• The value can be an empty string.
• After the custom parameters and the original script content are Base64 encoded, the total size cannot exceed 16 KB.
• The set of custom parameter names must be a subset of the parameter set that is defined when you created the script. You can use an empty string to represent the parameters that are not passed in.

Default value: null, indicating that this parameter is canceled and customer parameters are disabled.

Specifies whether to retain the script after it is run. Valid values:

• true: The script is retained. You can call the InvokeCommand operation to run the script again, call the DescribeCommands operation to query the script, and call the DeleteCommands operation to delete the script. The retained script takes up the quota of Cloud Assistant scripts.
• false: The script is not retained. It is automatically deleted after running, without taking up the quota of Cloud Assistant scripts.

Default value: false