Modifies the parameters and content of a Cloud Assistant command.
Operation description
You can modify a command when it is run. After the command is modified, the new command content applies to subsequent executions.
You cannot modify the command type. For example, you cannot change a shell command (RunShellScript) to a batch command (RunBatScript).
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The region ID of the command. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
CommandId | string | Yes | The command ID. You can call the DescribeCommands operation to query all available command IDs. | c-hz01272yr52**** |
Name | string | No | The command name. The name supports all character sets and can be up to 128 characters in length. | test-CommandName |
Description | string | No | The command description. The description supports all character sets and can be up to 512 characters in length. | This is description. |
CommandContent | string | No | The command content. The command content can be plaintext or Base64-encoded. Take note of the following items:
| echo |
WorkingDir | string | No | The working directory of the command. | /home/ |
Timeout | long | No | The maximum timeout period for the command to be run on the instance. Unit: seconds. When a command cannot run within the specified time range, the command times out. Then, the command process is forcibly terminated by canceling the process ID (PID) of the command. | 120 |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "0DE9B41E-EF0D-40A0-BB43-37749C5BDA9C"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | RegionId.ApiNotSupported | The 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. |
400 | InvalidParameter.WorkingDir | The specified parameter WorkingDir is not valid. | - |
403 | CmdName.Readonly | The command name is readonly after publishing. | The command is published and cannot have its name changed. |
403 | CmdName.ExceedLimit | The length of the command name exceeds the upper limit. | The length of the command name exceeds the upper limit. |
403 | CmdContent.ExceedLimit | The length of the command content exceeds the upper limit. | The length of command content exceeds the upper limit. |
403 | CmdDesc.ExceedLimit | The length of the command description exceeds the upperlimit. | The length of the command description exceeds the upper limit. |
403 | Operation.Forbidden | The operation is not permitted. | The operation is not supported. |
404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | The RegionId provided does not exist |
404 | InvalidCmdId.NotFound | The 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. |
500 | InternalError.Dispatch | An 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 time | Summary of changes | Operation | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-05-12 | The Error code has changed | see changesets | ||||||||||
| ||||||||||||
2022-02-23 | The Error code has changed | see changesets | ||||||||||
| ||||||||||||
2022-02-23 | The Error code has changed | see changesets | ||||||||||
|