All Products
Search
Document Center

Elastic Compute Service:ModifyCommand

Last Updated:Apr 11, 2024

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

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

Authorization information

There is currently no authorization information disclosed in the API.

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

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

  • The Base64-encoded command content can be up to 16 KB in size.

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

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

    • Specify custom parameters in the {{}} format. When parameter names are enclosed in {{}}, 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 not case-sensitive.
    • Each custom parameter name cannot exceed 64 bytes in length.
echo
WorkingDirstringNo

The working directory of the command.

/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
The current API has no return parameters

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.
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
2023-05-12The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    delete Error Codes: 403
    delete Error Codes: 404
    delete Error Codes: 500
2022-02-23The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 403 change
    Error Codes 404 change
    delete Error Codes: 400
    Added Error Codes: 500
2022-02-23The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 403 change
    Error Codes 404 change
    delete Error Codes: 400
    delete Error Codes: 500