Call the PurchaseElasticityAssurance API - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Operation description

Make sure that you fully understand the billing methods and pricing of elastic capacity reservation before you use this operation.

Before you purchase an elastic capacity reservation service, you can call DescribeElasticityAssurances to query available elastic capacity reservation 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:PurchaseElasticityAssurance

update

*ElasticityAssurance

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the elastic capacity reservation service. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
Period	integer	No	The purchase duration. The unit of the duration is determined by the PeriodUnit parameter. Valid values: If PeriodUnit is set to Month: 1, 2, 3, 4, 5, 6, 7, 8, and 9. If PeriodUnit is set to Year: 1, 2, 3, 4, and 5. Default value: 1.	1
PeriodUnit	string	No	The unit of the purchase duration. Valid values: Month: month. Year: year. Default value: Year.	Month
PrivatePoolOptions.Id	string	Yes	The ID of the elastic capacity reservation service.	eap-bp67acfmxazb4****
ClientToken	string	No	Ensures the idempotence of the request. The value is generated from your client and must be unique among different requests. The `ClientToken` value 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
PrivatePoolOptions.MatchCriteria	string	No	The matching mode of the elastic capacity reservation service. Valid values: Open: open mode. The system automatically matches available open private pool capacity when instances are launched. If no matching private pool capacity is available, public pool resources are used. Target: targeted mode. Instances are launched by using the specified private pool capacity. If the specified private pool capacity is unavailable, the instances fail to be launched. Default value: Open.	Open
StartTime	string	No	The effective period of the elastic capacity reservation service. By default, the service takes effect when the operation is invoked. Specify the time in the ISO 8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time must be in UTC. For more information, see ISO 8601.	2024-06-18T00:00:00Z

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.MalFormed	The specified StartTime is out of the permitted range.	The specified StartTime value exceeds the maximum allowed value.
400	Invalid.PrivatePoolOptions.Id	The PrivatePool does not exist.	The private pool does not exist.
400	InvalidParameter.PeriodUnit	The specified PeriodUnit is not supported.	The specified PeriodUnit parameter is invalid.
401	InvalidUser.Unauthorized	The user is not authorized.	The account you are currently using does not have permission.
500	InternalError	Internal error.	An error occurred while sending the request. Try again later.
403	IncorrectPrivatePoolStatus	The current status of the private pool does not support this operation.	The specified private pool state does not support the operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.