All Products
Search
Document Center

Elastic Compute Service:ModifyCommand

Last Updated:Sep 29, 2024

Modifies the parameters 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

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:ModifyCommandupdate
  • Command
    acs:ecs:{#regionId}:{#accountId}:command/{#commandId}
    none
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
CommandIdstringYes

The command ID. You can call the DescribeCommands operation to query all available command IDs.

c-hz01272yr52****
NamestringNo

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

test-CommandName
DescriptionstringNo

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

This is description.
CommandContentstringNo
Note This parameter is no longer used and does not take effect.
echo
WorkingDirstringNo

The working directory of the command. The value can be up to 200 characters in length.

/home/
TimeoutlongNo

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

ParameterTypeDescriptionExample
object

The ID of the request.

RequestIdstring

The ID of the request.

0DE9B41E-EF0D-40A0-BB43-37749C5BDA9C

Examples

Sample success responses

JSONformat

{
  "RequestId": "0DE9B41E-EF0D-40A0-BB43-37749C5BDA9C"
}

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.
400InvalidParameter.WorkingDirThe specified parameter WorkingDir is not valid.-
403CmdName.ReadonlyThe command name is readonly after publishing.The command is published and cannot have its name changed.
403CmdName.ExceedLimitThe length of the command name exceeds the upper limit.The length of the command name exceeds the upper limit.
403CmdContent.ExceedLimitThe length of the command content exceeds the upper limit.The length of command content exceeds the upper limit.
403CmdDesc.ExceedLimitThe length of the command description exceeds the upperlimit.The length of the command description exceeds the upper limit.
403Operation.ForbiddenThe operation is not permitted.The operation is not supported.
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.
404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.The RegionId provided 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.
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-05-11The Error code has changedView Change Details
2023-05-12The Error code has changedView Change Details
2022-02-23The Error code has changedView Change Details
2022-02-23The Error code has changedView Change Details