Renew elasticity assurances by calling RenewElasticityAssurances - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Renews one or more purchased elasticity assurance services.

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

create

*ElasticityAssurance

acs:ecs:{#regionId}:{#accountId}:elasticityassurance/{#ElasticityAssuranceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID of the elasticity assurance service. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
Period	integer	No	The renewal duration. The unit of the duration is determined by the `PeriodUnit` parameter. Valid values: When `PeriodUnit` is set to `Weekly`: 1, 2, and 3. When `PeriodUnit` is set to `Month`: 1, 2, 3, 4, 5, 6, 7, 8, and 9. When `PeriodUnit` is set to `Year`: 1, 2, 3, 4, and 5. Default value: 1.	1
PeriodUnit	string	No	The unit of the renewal duration. Valid values: Weekly: week Month: month Year: year Default value: 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 make sure that the token is unique among different requests. `ClientToken` supports only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.	123e4567-e89b-12d3-a456-426655440000
AutoPay	boolean	No	Specifies whether to enable automatic payment. Valid values: true: Automatic payment is enabled. false: Automatic payment is not enabled. Default value: true.	true
PrivatePoolOptions.Id	array	No	The list of elasticity assurance service IDs. Limit: You can renew up to 20 elasticity assurance services at a time. You can call DescribeElasticityAssurances to query purchased elasticity assurance services.
	string	No	The elasticity assurance service ID.	eap-bp67acfmxazb4****
AutoRenew	boolean	No	Specifies whether to enable auto-renewal. Valid values: true: Auto-renewal is enabled. false: Auto-renewal is not enabled. Default value: false.	true
AutoRenewPeriod	integer	No	The auto-renewal duration. Unit: months. Valid values: 1, 2, 3, 6, 12, 24, and 36. When `PeriodUnit=Month`, the default value is 1. When `PeriodUnit=Year`, the default value is 12. Note This parameter is required when `AutoRenew` is set to `true`.	1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
OrderId	string	The renewal order ID.	182372800****
PrivatePoolOptionsIdSet	object
PrivatePoolOptionsId	array	The list of elasticity assurance service IDs.
	string	The elasticity assurance service ID.	eap-bp67acfmxazb4****

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "OrderId": "182372800****",
  "PrivatePoolOptionsIdSet": {
    "PrivatePoolOptionsId": [
      "eap-bp67acfmxazb4****"
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidPeriodUnit.ValueNotSupported	The specified parameter PeriodUnit is not valid.	The specified PeriodUnit parameter is invalid.
400	InvalidChargeType.ValueNotSupported	ChargeType is not valid.
400	MissingParameter.PrivatePoolOptions.Id	The specified parameter PrivatePoolOptions.Id does not exist.	The specified parameter PrivatePoolOptions.Id does not exist
400	InvalidParameter.PeriodUnit	The specified PeriodUnit is invalid.	The specified PeriodUnit is invalid
400	InvalidParameter.Period	The specified parameter Period or PeriodUnit is invalid.	The specified Period or PeriodUnit parameter does not meet the requirements.
400	InvalidParameter.PrivatePoolOptionsId	The specified parameter PrivatePoolOptions.Id is invalid.	The specified parameter PrivatePoolOptions.Id is invalid
400	InvalidAutoRenewPeriod.ValueNotSupported	The specified autoRenewPeriod is invalid.	The specified auto-renewal duration is invalid.
500	InternalError	The request processing has failed due to some unknown error.
500	IncorrectPrivatePoolStatus	The current status of the private pool does not support this operation.
500	InvalidPrivatePoolId.NotFound	The specified private pool does not exist.	The specified private pool does not exist
403	InvalidParameter.ResourceOwnerAccount	ResourceOwnerAccount is Invalid.	The specified ResourceOwnerAccount parameter is invalid.
403	Account.Arrearage	Your account has been in arrears.
403	ChargeTypeViolation	The operation is not permitted due to charge type of the instance.
403	InvalidOperation.PackageTypeUnsupported	Not support to renew this type of resource package.	Not support to renew this type of resource package.
403	OperationDenied.UtilizationTooLow	The utilization of this ElasticityAssurance is below 20%, renewal is not allowed. Please improve the utilization and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.