RenewReservedInstances-阿里云帮助中心

Renews one or more reserved instances. When you renew reserved instances, you can specify a validity period (renewal period) and whether to enable auto-renewal for the reserved instances.

Operation description

Before you call this operation, make sure that you are familiar with the billing and pricing of reserved instances.

You can manually renew reserved instances or enable auto-renewal for reserved instances. For more information, see the Renewal section of the "Reserved instances" topic.
You can call the DescribeReservedInstances operation to query the reserved instances that you purchased.
You can call this operation to enable auto-renewal for reserved instances but cannot call this operation to disable auto-renewal for reserved instances. To disable auto-renewal for a reserved instance, call the ModifyReservedInstanceAutoRenewAttribute operation.

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

create

*ReservedInstance

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

None

Request parameters

Parameter	Type	Required	Description	Example
ReservedInstanceId	array	No	The IDs of the reserved instances.
	string	No	The ID of the reserved instance. You can call the DescribeReservedInstances operation to query the IDs of reserved instances that you purchased. You can specify up to 10 IDs of reserved instances in a single request.	ecsri-2ze53qonjqxg7r****
RegionId	string	No	The region ID of the reserved instance. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
Period	integer	No	The validity period of the reserved instance. Valid values: 1 and 3. Default value: 1.	1
PeriodUnit	string	No	The unit of the validity period of the reserved instance. Set the value to Year.	Year
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.	123e4567-e89b-12d3-a456-426655440000
AutoRenew	boolean	No	Specifies whether to enable auto-renewal for the reserved instance. Valid values: true false Default value: false.	true
AutoRenewPeriod	integer	No	The auto-renewal duration. Unit: months. This parameter takes effect only when AutoRenew is set to true. Valid values: 12 and 36. Default value: 12.	1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	8C314443-AF0D-4766-9562-C83B7F1****
ReservedInstanceIdSets	object
ReservedInstanceId	array	The IDs of the reserved instances.
	string	The ID of the reserved instance.	ecsri-2ze53qonjqxg7r****
OrderId	string	The order ID.	2023912123****

Examples

Success response

JSON format

{
  "RequestId": "8C314443-AF0D-4766-9562-C83B7F1****",
  "ReservedInstanceIdSets": {
    "ReservedInstanceId": [
      "ecsri-2ze53qonjqxg7r****"
    ]
  },
  "OrderId": "2023912123****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidInstanceType.ValueUnauthorized	The specified InstanceType is not authorized.
400	InvalidParameter.Conflict	The specified region and cluster do not match.	The specified region and cluster do not correspond to each other.
400	InvalidTagKey.Malformed	The specified Tag.n.Key is not valid.	The specified Tag.N.Key parameter is invalid.
400	InvalidPeriodUnit.ValueNotSupported	The specified parameter PeriodUnit is not valid.	The specified PeriodUnit parameter is invalid.
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.	The specified tag value is invalid.
400	InvalidChargeType.ValueNotSupported	ChargeType is not valid.
400	OperationDenied	The specified InstanceType or Zone is not authorized for current user.
400	InvalidPeriod	The specified Period or PeriodUnit is not correct.
400	MissingParameter.ReservedInstanceIds	The specified ReservedInstanceIds does not exist.
400	InvalidParameter.PeriodUnit	The specified PeriodUnit is invalid.	The specified PeriodUnit is invalid
400	InvalidParameter.Period	The specified Period is invalid.
400	InvalidParameter.ReservedInstanceIds	The specified ReservedInstanceIds is invalid.
400	InvalidPeriod.ExceededMaximumExpiration	The specified renewal period cannot exceed the maximum expiration date. We recommend you try shortening the renewal period at next attempt.
500	InternalError	The request processing has failed due to some unknown error.
403	OperationDenied.NoStock	The requested resource is sold out in the specified zone; try other types of resources or other regions and zones.	The requested resources are insufficient.
403	OperationDenied	Sales of this resource are temporarily suspended in the specified region; please try again later.	The requested resource is unavailable in the specified region. Try again later.
403	NodeControllerUnavailable	The Node Controller is temporarily unavailable.
403	InvalidParameter.ResourceOwnerAccount	ResourceOwnerAccount is Invalid.	The specified ResourceOwnerAccount parameter is invalid.
403	Zone.NotOpen	The specified zone is not granted to you to buy resources yet.
403	Zone.NotOnSale	The specified zone is not available for purchase.	The requested resources are unavailable in the specified zone. Try a different instance type or select a different region or zone.
403	Account.Arrearage	Your account has been in arrears.
403	InvalidReservedInstanceName.Malformed	The specified parameter ReservedInstanceName is invalid.
403	InvalidParameter.Scope	The specified parameter 'Scope' is invalid.
403	InvalidReservedInstanceStatus.ValueNotSupported	ReservedInstance status is not supported.
403	InvalidReservedInstanceOfferingType.ValueNotSupported	The OfferingType is not supported.
403	InvalidReservedInstanceOfferingClass.ValueNotSupported	The OfferingClass is not supported.
403	MissingParameter.ZoneId	The specified zoneId should be not empty.
403	MissingParameter.InstanceType	The instanceType should be not empty.
403	MissingParameter.ReservedInstanceId	The ids of reservedInstance can not be empty.
403	MissingParameter.ReservedInstanceConfiguration	The configurations of reservedInstance can not be empty.
403	InvalidParameter.SplitOrMerge	The Many-to-many of modification is not supported.
403	MissingParameter.InstanceTypeAndAmountBothEmpty	The instanceType and amount can not be both empty.
403	InvalidReservedInstancePlatform.ValueNotSupported	The Platform is not supported.
403	InvalidParameter.ReservedInstanceName	The reservedInstanceName is invalid.	reservedInstanceName field value is illegal
403	InvalidReservedInstanceZone.ValueNotSupported	The zoneId is not exist.
403	InvalidParameter.ValueNotSupported	The instanceTypeFamily of the instance to be changed must be consistent.
403	IncorrectInstanceStatus	The status of specified reservedInstance must be active.
403	InvalidPlatform.ValueNotSupported	The platform of reservedInstance is invalid.
403	InvalidScope.ValueNotSupported	The scope of reservedInstance is invalid, The valid value is Zone or Region.
403	InvalidConfiguration.ValueNotSupported	The modification Configuration should not be empty.
403	InvalidZoneId.ValueNotSupported	The specified zoneId should be same.
403	InvalidParameter	The parameter is invalid.Please check it.
403	InvalidInstanceAmount.ValueNotSupported	The instanceAmount is invalid.
403	OperationDenied.OnlyModifyName	It is not allowed to modify the ReservedInstanceName only.	The reserved instance name cannot be separately modified.
403	InvalidReservedInstanceId.NotFound	The specified parameter ReservedInstanceId is invalid.
403	ChargeTypeViolation	The operation is not permitted due to charge type of the instance.
404	InvalidZoneId.NotFound	The ZoneId provided does not exist in our records.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.