ModifyCommand-阿里云帮助中心

Modifies the parameters of a Cloud Assistant command.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:ModifyCommand

update

*Command

acs:ecs:{#regionId}:{#accountId}:command/{#commandId}

None

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
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	Note This parameter is no longer used and does not take effect.	echo
WorkingDir	string	No	The working directory of the command. The value can be up to 200 characters in length.	/home/
Timeout	integer	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
Launcher	string	No	The launcher for script execution. The value cannot exceed 1 KB in length.	python3 -u {{ACS::ScriptFileName\|Ext(".py")}}

Response elements

Element	Type	Description	Example
	object	The ID of the request.
RequestId	string	The ID of the request.	0DE9B41E-EF0D-40A0-BB43-37749C5BDA9C

Examples

Success response

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.
500	InternalError.Dispatch	An error occurred when you dispatched the request.	An error occurred while the request is being sent. Try again later.
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.
403	InvalidParameterCharacter.CommandName	The command Name contains illegal characters.	The command Name contains illegal characters.
403	InvalidParameterCharacter.CommandDescription	The command Description contains illegal characters.	The command Description contains illegal characters.
403	InvalidParameterCharacter.CommandWorkingDir	The command WorkingDir contains illegal characters.	The command WorkingDir contains illegal characters.
403	InvalidLauncher.LengthLimitExceeded	The 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.
403	InvalidTimeout.ExceedLimit	The specified parameter Timeout exceeds the upper limit.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	Region information error
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.