PurchaseElasticityAssurance - Elastic Compute Service

Purchases an elasticity assurance that is not in the Active state and for which resources are prepared.

Operation description

Before you call this operation, familiarize yourself with the billing rules and pricing of elasticity assurances.

Before you purchase an elasticity assurance, you can call the DescribeElasticityAssurances operation to query the elasticity assurances that you can purchase.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ecs:PurchaseElasticityAssurance	update	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the elasticity assurance. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
Period	integer	No	The term of the elasticity assurance. The unit of the term is determined by the PeriodUnit value. Valid values: When the PeriodUnit parameter is set to Month, valid values are 1, 2, 3, 4, 5, 6, 7, 8, and 9. When the PeriodUnit parameter is set to Year, valid values are 1, 2, 3, 4, and 5. Default value: 1.	1
PeriodUnit	string	No	The unit of the term of the elasticity assurance. Valid values: Month Year Default value: Year.	Month
PrivatePoolOptions.Id	string	Yes	The ID of the elasticity assurance.	eap-bp67acfmxazb4****
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
PrivatePoolOptions.MatchCriteria	string	No	The type of the private pool that is associated with the elasticity assurance. Valid values: Open: open private pool. If you use the elasticity assurance to create ECS instances, the open private pool that is associated with the elasticity assurance is automatically matched. If no capacity is available in the open private pool, resources in the public pool are automatically used to create the ECS instances. Target: targeted private pool. If you use the elasticity assurance to create ECS instances, the targeted private pool that is associated with the elasticity assurance is automatically matched. If no capacity is available in the private pool, the ECS instances fail to be created. Default value: Open.	Open
StartTime	string	No	The time when the elasticity assurance takes effect. The default value is the time when the elasticity assurance is created. 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:00Z

Response parameters

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

Examples

Sample success responses

JSONformat

{
  "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.
403	IncorrectPrivatePoolStatus	The current status of the private pool does not support this operation.	The specified private pool state does not support the operation.
500	InternalError	Internal error.	-
500	InternalError	%s	An internal error has occurred.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history