All Products
Search
Document Center

Elastic Compute Service:RunCommand

Last Updated:Sep 29, 2024

Runs a shell, PowerShell, or batch command on one or more Elastic Compute Service (ECS) instances. When you call this operation, you can specify parameters, such as Type and CommandContent, in the request.

Operation description

Usage notes

Unlike the CreateCommand and InvokeCommand operations, the RunCommand operation can be used to create and run a command in a single request.

Take note of the following items:

  • The instances on which you want to run a command must be in the Running (Running) state. You can call the DescribeInstances operation to query the status of instances.

  • Cloud Assistant Agent must be installed on the instances.

  • Before you run a PowerShell command on a Windows instance, make sure that the PowerShell module is installed on the instance.

  • When you use a cron expression to specify a schedule, you can specify a time zone based on your business requirements. If you do not specify a time zone, the schedule is determined by the system time of the instances. Make sure that the time or time zone of the instances meets your business requirements. For information about time zones, see Configure the NTP service for ECS instances that run CentOS 6 or Configure the NTP service for Windows instances.

  • You can set Timeout to specify the timeout period for executions of the command on ECS instances. If an execution times out, Cloud Assistant Agent forcefully terminates the command process.

    • When the one-time execution of the command times out, the execution state ( InvokeRecordStatus ) of the command becomes Failed.
    • For a scheduled task, the timeout period takes effect on each execution of the command. When a command execution times out, the subsequent executions of the command are not affected. When a scheduled execution of the command times out, the execution state ( InvokeRecordStatus ) of the command becomes Failed.

    To ensure that scheduled tasks can run as expected, make sure that the version of Cloud Assistant Agent is not earlier than the following ones. A scheduled task can run a command at a specified interval, only once at a specified time, or at designated times based on a cron expression in a specified year or time zone. If the ClientNeedUpgrade error code is returned, you must update Cloud Assistant Agent to the latest version. For more information, see Upgrade or disable upgrades of Cloud Assistant Agent.

    - Linux: 2.2.3.282.
    - Windows: 2.1.3.282.
    
  • Command executions may fail due to instance status exceptions, network exceptions, or exceptions on Cloud Assistant Agent. If a command execution fails, no execution information is generated. For more information, see the Command errors and solutions section in the "Check execution results and troubleshoot common issues" topic.

  • If you set EnableParameter to true, the custom parameter feature is enabled. When you configure CommandContent, you can define custom parameters in the {{parameter}} format. Then, when the command is run, the key-value pairs of the custom parameters are passed in.

  • You can retain up to 500 to 50,000 Cloud Assistant commands in each region. You can also apply for a quota increase. For information about how to query and increase quotas, see Manage quotas.

  • Before you run a command on instances, especially new instances, we recommend that you call the DescribeCloudAssistantStatus operation to query the status of Cloud Assistant Agent on the instances and run the command when the value of CloudAssistantStatus in the response is true for the instances.

Debugging

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

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ecs:RunCommandupdate
  • All Resources
    *
  • ecs:CommandRunAs
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-hangzhou
ResourceGroupIdstringNo

The ID of the resource group to which to assign the command executions. When you set this parameter, take note of the following items:

  • The instances specified by InstanceId.N must belong to the specified resource group.
  • After the command is run, you can set this parameter to call the DescribeInvocations or DescribeInvocationResults operation to query the execution results in the specified resource group.
rg-bp67acfmxazb4p****
NamestringNo

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 language type of the command. Valid values:

  • RunBatScript: batch command, applicable to Windows instances.
  • RunPowerShellScript: PowerShell command, applicable to Windows instances.
  • RunShellScript: shell command, applicable to Linux instances.
RunShellScript
CommandContentstringYes

The content of the command. The command content can be plaintext or Base64-encoded. Take note of the following items:

  • If you want to retain the command, make sure that the Base64-encoded command content does not exceed 18 KB in size. If you do not want to retain the command, make sure that the Base64-encoded command content does not exceed 24 KB in size. You can set the KeepCommand parameter to specify whether to retain the command.

  • If the command content is encoded in Base6, set ContentEncoding to Base64.

  • If you set the EnableParameter parameter to true, the custom parameter feature is enabled and you can configure custom parameters based on the following rules:

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

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

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

    • {{ACS::InstanceId}}: the instance ID. If you want to run the command on multiple instances and specify {{ACS::InstanceId}} as a built-in environment parameter, make sure that the Cloud Assistant Agent version 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 Cloud Assistant Agent version is not earlier than the following ones:

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

      • Linux: 2.2.3.309
      • Windows: 2.1.3.309
    • {{ACS::CommandId}}: the ID of the command. If you want to specify {{ACS::CommandId}} as a built-in environment parameter, make sure that the Cloud Assistant Agent version 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. The value can be up to 200 characters in length.

Default values:

  • For Linux instances, the default value is /root, which is the home directory of the administrator (the root user).
  • For Windows instances, the default value is the directory where the Cloud Assistant Agent process resides, such as C:\Windows\System32.
/home/user
TimeoutlongNo

The timeout period for the command execution. Unit: seconds.

A timeout error occurs if the command cannot be run because the process slows down or because a specific module or Cloud Assistant Agent does not exist. When an execution times out, the command process is forcefully terminated.

Default value: 60.

3600
EnableParameterbooleanNo

Specifies whether to include custom parameters in the command.

Default value: false.

false
RepeatModestringNo

Specifies how to run the command. Valid values:

  • Once: immediately runs the command.
  • Period: runs the command on a schedule. If you set this parameter to Period, you must specify Frequency.
  • NextRebootOnly: runs the command the next time the instance is started.
  • EveryReboot: runs the command every time the instance is started.

Default values:

  • If you do not specify the Frequency parameter, the default value is Once.
  • If you specify the Frequency parameter, Period is used as the value of RepeatMode regardless of whether RepeatMode is set to Period.

Take note of the following items:

  • You can call the StopInvocation operation to stop the pending or scheduled executions of the command.
  • If you set this parameter to Period or EveryReboot, you can call the DescribeInvocationResults operation with IncludeHistory set to true to query the results of historical scheduled executions.
Once
TimedbooleanNo
Note This parameter is no longer used and does not take effect.
true
FrequencystringNo

The schedule on which to run the command. You can configure a command to run at a fixed interval based on a rate expression, run only once at a specified time, or run at designated times based on a cron expression.

  • To run a command at a fixed interval, use a rate expression to specify the interval. You can specify the interval in seconds, minutes, hours, or days. This option is suitable for scenarios in which tasks need to be executed at a fixed interval. Specify the interval in the following format: rate(<Execution interval value> <Execution interval unit>). For example, specify rate(5m) to run the command every 5 minutes. When you specify an interval, take note of the following limits:

    • The interval can be anywhere from 60 seconds to 7 days, but must be longer than the timeout period of the scheduled task.
    • The interval is the amount of time that elapses between two consecutive executions. The interval is irrelevant to the amount of time that is required to run the command once. For example, assume that you set the interval to 5 minutes and that it takes 2 minutes to run the command each time. Each time the command is run, the system waits 3 minutes before the system runs the command again.
    • A task is not immediately executed after the task is created. For example, assume that you set the interval to 5 minutes for a task. The task begins to be executed 5 minutes after it is created.
  • To run a command only once at a specific time, specify a point in time and a time zone. Specify the point in time in the at(yyyy-MM-dd HH:mm:ss <Time zone>) format, which indicates at(Year-Month-Day Hour:Minute:Second <Time zone>). If you do not specify a time zone, the UTC time zone is used by default. You can specify the time zone in the following forms:

    • The time zone name. Examples: Asia/Shanghai and America/Los_Angeles.
    • The time offset from GMT. Examples: GMT+8:00 (UTC+8) and GMT-7:00 (UTC-7). If you use the GMT format, you cannot add leading zeros to the hour value.
    • The time zone abbreviation. Only UTC is supported.

    For example, to configure a command to run only once at 13:15:30 on June 6, 2022 (Shanghai time), set the time to at(2022-06-06 13:15:30 Asia/Shanghai). To configure a command to run only once at 13:15:30 on June 6, 2022 (UTC-7), set the time to at(2022-06-06 13:15:30 GMT-7:00).

  • To run a command at specific times, use a cron expression to define the schedule. Specify a schedule in the <Cron expression> <Time zone> format. The cron expression is in the <seconds> <minutes> <hours> <day of the month> <month> <day of the week> <year (optional)> format. The system calculates the execution times of the command based on the specified cron expression and time zone and runs the command as scheduled. If you do not specify a time zone, the system time zone of the instance on which you want to run the command is used by default. For more information about cron expressions, see Cron expressions. You can specify the time zone in the following forms:

    • The time zone name. Examples: Asia/Shanghai and America/Los_Angeles.
    • The time offset from GMT. Examples: GMT+8:00 (UTC+8) and GMT-7:00 (UTC-7). If you use the GMT format, you cannot add leading zeros to the hour value.
    • The time zone abbreviation. Only UTC is supported. For example, to configure a command to run at 10:15:00 every day in 2022 (Shanghai time), set the schedule to 0 15 10 ? * * 2022 Asia/Shanghai. To configure a command to run every half an hour from 10:00:00 to 11:30:00 every day in 2022 (UTC+8), set the schedule to 0 0/30 10-11 * * ? 2022 GMT+8:00. To configure a command to run every 5 minutes from 14:00:00 to 14:55:00 every October every two years from 2022 in UTC, set the schedule to 0 0/5 14 * 10 ? 2022/2 UTC.

    **

    Note The minimum interval must be 10 seconds or more and cannot be shorter than the timeout period of scheduled executions.

0 */20 * * * ?
ParametersobjectNo

The key-value pairs of the custom parameters that are passed in when the command that can include custom parameters is run. For example, assume that the command content is echo {{name}}. The Parameter parameter can be used to pass in the {"name":"Jack"} key-value pair. 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 run.

You can specify up to 10 custom parameters. Take note of the following items:

  • The key cannot be an empty string. It can be up to 64 characters in length.
  • The value can be an empty string.
  • If you want to retain the command, make sure that the command after Base64 encoding, including custom parameters and original command content, does not exceed 18 KB in size. If you do not want to retain the command, make sure that the command after Base64-encoding does not exceed 24 KB in size. You can set KeepCommand to specify whether to retain the command.
  • The custom parameter names that are specified by Parameters must be included in the custom parameter names that you specified when you created the command. You can use empty strings to represent the parameters that are not passed in.

This parameter is empty by default. You can leave this parameter empty to disable the custom parameter feature.

{"name":"Jack", "accessKey":"LTAIdyvdIqaRY****"}
KeepCommandbooleanNo

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

  • true: retains the command. Then, you can call the InvokeCommand operation to rerun the command. The retained command counts against the quota of Cloud Assistant commands.
  • false: does not retain the command. The command is automatically deleted after it is run and does not count against the quota of Cloud Assistant commands.

Default value: false.

false
ContentEncodingstringNo

The encoding mode of command content (CommandContent). The valid values are case-insensitive. Valid values:

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

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

Base64
UsernamestringNo

The username to use to run the command on the ECS instances. The username cannot exceed 255 characters in length.

  • For Linux instances, the root username is used by default.
  • For Windows instances, the System username is used by default.

You can also specify other usernames that already exist in the instances to run the command. For security purposes, we recommend that you run Cloud Assistant commands as a regular user. For more information, see Run Cloud Assistant commands as a regular user.

test
WindowsPasswordNamestringNo

The name of the password to use to run the command on a Windows instance. The name cannot exceed 255 characters in length.

If you do not want to use the default System user to run the command on Windows instances, specify both WindowsPasswordName and Username. To mitigate the risk of password leaks, the password is stored in plaintext in CloudOps Orchestration Service (OOS) Parameter Store, and only the name of the password is passed in by using WindowsPasswordName. For more information, see Manage encryption parameters and Run Cloud Assistant commands as a regular user.

Note If you use the root username for Linux instances or the System username for Windows instances to run the command, you do not need to specify WindowsPasswordName.
axtSecretPassword
InstanceIdarrayNo

The IDs of instances on which to run the command. N indicates that you can specify multiple instance IDs at the same time. Valid values of N: 1 to 100.

If one of the specified instances does not meet the conditions for running the command, the call fails. To ensure that the call is successful, specify only the IDs of instances that meet the conditions.

You can apply for a quota increase in the Quota Center console. The quota name is Maximum number of instances supported for command execution.

stringNo

The ID of instance N on which to run the command. Valid values of N: 1 to 100.

If one of the specified instances does not meet the conditions for running the command, the call fails. To ensure that the call is successful, specify only the IDs of instances that meet the conditions.

You can apply for a quota increase in the Quota Center console. The quota name is Maximum number of instances supported for command execution.

i-bp185dy2o3o6neg****
Tagarray<object>No

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

objectNo

The ID of the request.

KeystringNo

The key of tag N to add to the command task. 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 .

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 to add to the command task. Valid values of N: 1 to 20. The tag value can be an empty string.

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

TestValue
ContainerIdstringNo

The ID of the container. Only 64-bit hexadecimal strings are supported. docker://, containerd://, or cri-o:// can be used as the prefix to the container ID to specify the container runtime.

Take note of the following items:

  • If this parameter is specified, Cloud Assistant runs the command in the specified container of the instance.
  • If this parameter is specified, the command can run only on Linux instances on which Cloud Assistant Agent 2.2.3.344 or later is installed.
  • If this parameter is specified, the specified Username and WorkingDir parameters do not take effect. You can run the command in the default working directory of the container only by using the default user of the container. For more information, see Use Cloud Assistant to run commands in containers.
  • If this parameter is specified, only shell scripts can be run in Linux containers. You cannot add a command in the format similar to #!/usr/bin/python at the beginning of a script to specify a script interpreter. For more information, see Use Cloud Assistant to run commands in containers.
ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****
ContainerNamestringNo

The name of the container.

Take note of the following items:

  • If this parameter is specified, Cloud Assistant runs the command in the specified container of the instance.
  • If this parameter is specified, the command can run only on Linux instances on which Cloud Assistant Agent 2.2.3.344 or later is installed.
  • If this parameter is specified, the specified Username and WorkingDir parameters do not take effect. You can run the command in the default working directory of the container only by using the default user of the container. For more information, see Use Cloud Assistant to run commands in containers.
  • If this parameter is specified, only shell scripts can be run in Linux containers. You cannot add a command in the format similar to #!/usr/bin/python at the beginning of a script to specify a script interpreter. For more information, see Use Cloud Assistant to run commands in containers.
test-container
ClientTokenstringNo

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

123e4567-e89b-12d3-a456-426655440000
ResourceTagarray<object>No

The tags of the instance. If you do not specify InstanceId.N, the command is run on the instances that have the specified tags.

objectNo

Tag N of the instance. If you do not specify InstanceId.N, the command is run on the instances that have the specified tags.

KeystringNo

The key of tag N of the instance.

Take note of the following items:

  • This parameter and InstanceId.N are mutually exclusive.
  • Valid values of N: 1 to 10. The tag key cannot be an empty string.
  • The number of instances that have the specified tags cannot exceed 100. If more than 100 instances have the specified tags, we recommend that you use batch tags such as batch: b1 to group the instances into batches of up to 100 instances.
  • The tag key can be up to 64 characters in length and cannot contain http:// or https://. The tag key cannot start with acs: or aliyun.
TestKey
ValuestringNo

The value of tag N of the instance.

Take note of the following items:

  • Valid values of N: 1 to 10.
  • The tag value can be an empty string.
  • The tag value can be up to 128 characters in length and cannot contain http:// or https://.
TestValue
TerminationModestringNo

Specifies how to stop the command task when a command execution is manually stopped or times out. Valid values:

  • Process: stops the process of the command.
  • ProcessTree: stops the process tree of the command. In this case, the process of the command and all subprocesses of the process are stopped.
ProcessTree
LauncherstringNo

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

python3 -u {{ACS::ScriptFileName|Ext(".py")}}

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

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

The command ID.

c-7d2a745b412b4601b2d47f6a768d****
InvokeIdstring

The command task ID.

t-7d2a745b412b4601b2d47f6a768d****

Examples

Sample success responses

JSONformat

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

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.
400MissingParam.InstanceIdThe parameter instanceId is missing or empty.-
400NumberExceed.TagsEnsure the number of tag parameters is not greater than 20.-
400InvalidTagValue.MalformedThe specified Tag.n.Value is not valid.The specified tag value is invalid.
400Duplicate.TagKeyThe Tag.N.Key contain duplicate key.The specified tag key already exists. Tag keys must be unique.
400InvalidTagKey.MalformedThe specified Tag.n.Key is not valid.The specified Tag.N.Key parameter is invalid.
400MissingParameter.TagKeyYou must specify Tag.N.Key.The tag key is not specified.
400InvalidContainerId.MalformedThe specified parameter ContainerId is not valid.The specified container ID is invalid.
400InvalidContainerName.MalformedThe specified parameter ContainerName is not valid.The specified container name is invalid.
400InvalidClientToken.MalformedThe specified parameter clientToken is not valid.-
400CmdParam.EmptyKeyCommand parameters can not be empty.The custom parameters in the command must be specified.
400CmdParam.InvalidParamNameA command parameter name is invalid.The name of a custom parameter in the command is invalid.
400CmdContent.DecodeErrorThe CommandContent can not be base64 decoded.-
400InvalidInstance.NotMatchThe specified instance type does not match the command.The specified command cannot be run on the specified instance. Check whether the state of the instance meets the conditions for running the command.
400MissingParam.FrequencyThe frequency must be specified when you create a timed task.The Frequency parameter is required when you create a recurring task.
400InvalidParam.FrequencyThe specified frequency is invalid.The specified Frequency parameter is invalid.
400ParameterKey.DuplicateThe parameter may not contain duplicate keys.-
400Parameter.NotMatchedThe parameters of creation do not match those of invocation.-
400WindowsPasswordName.MissedWindowsPasswordName must be specified when you create a Windows task.-
400Parameter.DisabledParameters should not be passed when CreateCommand.EnableParameter is false.-
400InvalidParameter.WorkingDirThe specified parameter WorkingDir is not valid.-
400NumberExceed.ResourceTagsThe maximum number of ResourceTags is exceeded.-
400MissingParameter.ResourceTagKeyYou must specify ResourceTag.N.Key.-
400InvalidResourceTagKey.MalformedThe specified ResourceTag key is not valid.-
400InvalidResourceTagValue.MalformedThe specified ResourceTag value is not valid.-
400Duplicate.ResourceTagKeyThe ResourceTag contains duplicate keys.-
400InvalidResourceTag.InstanceNotFoundInstanceIds are not found by the specified ResourceTag.-
400InvalidResourceTag.ConflictWithInstanceIdsThe specified param ResourceTag conflicts with InstanceId.-
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.ExceedLimitYou've reached the limit on the count of command parameters.-
403CmdParamName.ExceedLimitThe length of the command parameter name exceeds the limit.-
403InstanceIds.ExceedLimitThe number of instance IDs exceeds the upper limit.The number of specified instance IDs exceeds the upper limit.
403Invocation.ExceedQuotaThe invocation quota in the current region has been reached for today.The maximum daily number of commands that can be run in the specified region has been reached.
403ParameterCount.ExceedLimitThe number of command parameters exceeds the maximum number that can be set.-
403ParameterKey.ExceedLimitThe length of the specified parameter key exceeds the maximum length that can be set.-
403ParameterType.NotSupportedThe type of parameter value is not supported.-
403Username.ExceedLimitThe length of the username exceeds the upper limit.The length of the username exceeds the upper limit.
403WindowsPasswordName.ExceedLimitThe length of the WindowsPasswordName exceeds the upper limit.-
403ParameterStore.NotSupportedParameter Store is not supported in this region.-
403TemporaryAccessKey.ErrorThe temporary accessKey is invalid.-
403ParameterStore.InvalidParametersThe parameter is invalid in Parameter Store.-
403ParameterStore.NoPermissionYou have no access to Parameter Store.-
403OperationDenied.BidOwnResourceBid user can not own resource.-
403Operation.ForbiddenThe operation is not permitted.The operation is not supported.
403IdempotentParameterMismatchThe specified parameter has changed while using an already used clientToken.-
403IdempotentProcessingThe previous idempotent request(s) is still processing.A previous idempotent request is being processed. Try again later.
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.
403InvalidParameterCharacter.CommandNameThe command Name contains illegal characters.The command Name contains illegal characters.
403InvalidParameterCharacter.CommandDescriptionThe command Description contains illegal characters.The command Description contains illegal characters.
403InvalidParameterCharacter.CommandWorkingDirThe command WorkingDir contains illegal characters.The command WorkingDir contains illegal characters.
403InvalidLauncher.LengthLimitExceededThe length of the parameter Launcher exceeds the limit of 1 KB characters.The length of the argument Launcher exceeds the limit of 1 KB characters.
404InvalidCmdType.NotFoundThe specified command type does not exist.-
404InvalidRepeatMode.NotFoundThe specified repeat mode does not exist.The specified command execution mode does not exist.
404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.The RegionId provided does not exist
404InvalidInstance.NotFoundThe specified instance does not exist.-
404InvalidCmdId.NotFoundThe specified command ID does not exist.The specified CommandId parameter is invalid. Check the parameter value. You can call the DescribeCommands operation to query all available command IDs.
404InvalidResourceGroup.NotFoundThe ResourceGroup provided does not exist in our records.The specified resource group does not exist.
404InvalidTerminationMode.NotFoundThe specified parameter TerminationMode does not exist.The specified parameter TerminationMode 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
2024-08-01The Error code has changed. The request parameters of the API has changedView Change Details
2024-05-14The Error code has changed. The request parameters of the API has changedView Change Details
2024-05-11The Error code has changedView Change Details
2024-04-12The Error code has changedView Change Details
2024-01-23The Error code has changed. The request parameters of the API has changedView Change Details
2023-11-20The Error code has changedView Change Details
2023-05-12The Error code has changedView Change Details
2023-04-25The Error code has changedView Change Details
2023-03-15The Error code has changedView Change Details
2022-01-06The Error code has changedView Change Details
2022-01-06The Error code has changedView Change Details