Modify reserved instance name and description with ModifyReservedInstanceAttribute - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

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:ModifyReservedInstanceAttribute

update

*ReservedInstance

acs:ecs:{#regionId}:{#accountId}:reservedinstance/{#reservedinstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the reserved instance.	cn-hangzhou
ReservedInstanceId	string	Yes	The new name of the reserved instance. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with `http://` or `https://`. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).	ecsri-uf61hdhue4kcorqsk****
ReservedInstanceName	string	No	The new description of the reserved instance. The description must be 2 to 256 characters in length. It cannot start with `http://` or `https://`. This parameter is empty by default.	testReservedInstanceName
Description	string	No	The error code.	ri-example

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The ID of the request.	200
Code	string	Modifies the attributes of a reserved instance, such as its name and description.	200
Message	string	The error message for this instance operation. The return value Success indicates that this operation is successful. For more information, see the "Error codes" section in this topic.	Success
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Code": "200",
  "Message": "Success",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	The request processing has failed due to some unknown error.
403	InvalidParameter.ReservedInstanceName	The reservedInstanceName is invalid.	reservedInstanceName field value is illegal
404	InvalidZoneId.NotFound	The ZoneId provided does not exist in our records.
404	InvalidReservedInstanceId.NotFound	The specified ReservedInstanceId does not exist.	The specified ReservedInstanceId resource does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.