Creates a capacity reservation. When you call this operation, you can specify parameters in the request, such as InstanceAmount, InstanceType, StartTime, and ZoneId.
Operation description
When you create a capacity reservation, you can specify attributes such as a zone and an instance type. The system uses a private pool to reserve resources that match the specified attributes. For more information, see Overview of Immediate Capacity Reservation.
-
Currently, only immediate capacity reservations are supported. Immediate capacity reservations take effect immediately after you purchase them. After you purchase an immediate capacity reservation, you are charged for the specified instance type based on the pay-as-you-go billing method regardless of whether you use the capacity reservation to create pay-as-you-go instances. Billing stops when you manually release the capacity reservation or when the capacity reservation expires and is automatically released.
- You can call the CreateInstance or RunInstances operation to specify private pool attributes when you create instances. To modify the attributes of a private pool, you can call the ModifyInstanceAttachmentAttributes operation. If an instance matches a private pool associated with a capacity reservation, you are charged based on the configurations of the instance such as the instance type, disks, and public bandwidth.
- Before you use a private pool associated with a capacity reservation to create pay-as-you-go instances, you are charged only for the specified instance type.
-
You can apply savings plans or regional reserved instances to offset hourly billing of unused immediate capacity reservations, and hourly fees of the instances that match the immediate capacity reservations. However, you cannot use zonal reserved instances to offset the hourly fees. We recommend that you purchase reserved instances or savings plans before you purchase immediate capacity reservations. This way, you can access resources free of charge within the coverage of the reserved instances or savings plans.
Debugging
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 Resourcesis 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:CreateCapacityReservation | create | *CapacityReservation acs:ecs:{#regionId}:{#accountId}:capacityreservation/* |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The ID of the region in which to create the capacity reservation. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| ResourceGroupId | string | No | The ID of the resource group to which you want to assign the capacity reservation. | rg-bp67acfmxazb4p**** |
| Tag | array<object> | No | The tags to add to the capacity reservation. | |
| object | No | |||
| Key | string | No | The key of tag N to add to the capacity reservation. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot contain | TestKey |
| Value | string | No | The value of tag N to add to the capacity reservation. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot contain | TestValue |
| ClientToken | string | No | The client token that is used to ensure the idempotency 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 | 0c593ea1-3bea-11e9-b96b-88e9fe637760 |
| PrivatePoolOptions.Name | string | No | The capacity reservation name. The name must be 2 to 128 characters in length. It must start with a letter but cannot start with | crpTestName |
| Description | string | No | The description of the capacity reservation. The description must be 2 to 256 characters in length and cannot start with This parameter is empty by default. | This is description. |
| PrivatePoolOptions.MatchCriteria | string | No | The type of the private pool to generate after the capacity reservation takes effect. Valid values:
Default value: Open. | Open |
| InstanceAmount | integer | Yes | The total number of instances for which the capacity of an instance type is reserved. | 2 |
| InstanceType | string | Yes | The instance type. You can create a capacity reservation to reserve the capacity of only one instance type. You can call the DescribeInstanceTypes operation to query the instance types provided by ECS. | ecs.g6.xlarge |
| StartTime | string | No | The mode in which the capacity reservation takes effect. You can call the CreateCapacityReservation operation to create only immediate capacity reservations. Note
If you do not specify this parameter, the capacity reservation immediately takes effect.
| 2021-10-30T05:32:00Z |
| EndTime | string | No | The time when the capacity reservation expires. Specify the time in the ISO 8601 standard in the | 2021-10-30T06:32:00Z |
| EndTimeType | string | No | The release mode of the capacity reservation. Valid values:
| Unlimited |
| Platform | string | No | The operating system of the image used by the instance. This parameter corresponds to the
Default value: Linux. Note
This parameter is unavailable.
| Linux |
| ZoneId | array | Yes | The ID of the zone in which you want to create the capacity reservation. A capacity reservation can reserve resources within only one zone. | |
| string | Yes | The ID of the zone in which you want to create the capacity reservation. A capacity reservation can reserve resources within only one zone. | cn-hangzhou-h |
Response parameters
Examples
Sample success responses
JSONformat
{
"PrivatePoolOptionsId": "crp-bp67acfmxazb4****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | NoStock | It has not enough stock in the iz. | - |
| 400 | MissingParameter | The input parameter StartTime is missing. | - |
| 400 | OperationDenied | The specified InstanceType or Zone is not available or not authorized. | The specified instance type or zone is unavailable or you are not authorized to use the specified instance type or access the specified zone. |
| 400 | MissingParameter.RegionId | The specified RegionId should not be null. | The RegionId parameter is required. |
| 400 | InvalidStartTime.NotSupported | The specified StartTime should be within 180 calendar days from the current date, and you must specify a precision to hour. | The specified StartTime value is out of range. |
| 400 | InvalidStartTime.MalFormed | The specified StartTime is out of the permitted range. | The specified StartTime value exceeds the maximum allowed value. |
| 400 | Invalid.PrivatePoolOptionsName.MalFormed | The specified PrivatePoolOptions.Name is not valid. | - |
| 400 | Invalid.ZoneId | The specified ZoneId is not valid. | - |
| 400 | Invalid.InstanceType | The specified InstanceType is not valid. | - |
| 400 | DedicatedHostNotSupported | DedicatedHost is not supported for PrivatePool. | The private pool does not support dedicated hosts. |
| 400 | SpotNotSupported | Spot is not supported for PrivatePool. | The private pool does not support preemptible instances. |
| 400 | ClassicNetworkNotSupported | Classic network is not supported for PrivatePool. | The private pool does not support instances in the classic network. |
| 400 | Invalid.InstanceId | Instance does not exist. | The specified instance does not exist. |
| 400 | Invalid.PrivatePoolOptions.MatchCriteria | Target mode does not support this operation. | The operation is not supported while the PrivatePoolOptions.MatchCriteria parameter is set to Target. |
| 400 | MissingParameter.PrivatePoolOptions.Id | The specified PrivatePoolOptions.Id should not be null. | The PrivatePoolOptions.Id parameter is required. |
| 400 | Invalid.PrivatePoolOptions.Id | The PrivatePool does not exist. | The private pool does not exist. |
| 400 | Invalid.InstanceType | The InstanceType does not match the PrivatePool. | The instance type and the private pool do not match. |
| 400 | Invalid.InstanceChargeType | The InstanceChargeType does not match the PrivatePool. | The instance billing method and the private pool do not match. |
| 400 | Invalid.ZoneId | The ZoneId does not match the PrivatePool. | The zone and the private pool do not match. |
| 400 | Invalid.PrivatePoolOptions.status | The PrivatePool has been used up. | - |
| 400 | Invalid.PrivatePoolOptions.MatchCriteria | The PrivatePoolOptions.MatchCriteria does not match the PrivatePool. | The specified PrivatePoolOptions.MatchCriteria parameter does not match the private pool. |
| 400 | InvalidPlatform.ValueNotSupported | The Platform does not match the PrivatePool. | The specified Platform parameter does not match the private pool. |
| 400 | Invalid.PrivatePoolOptions.status | The PrivatePool is expired or inactive. | - |
| 400 | Invalid.PrivatePoolOptions.status | The PrivatePool status is not valid. | - |
| 400 | Invalid.PrivatePoolOptions.status | The Instance should be created within 48 hours once the PrivatePool is started. | - |
| 400 | InvalidAliUid | The PrivatePool does not belong to the user of the Instance. | The specified private pool does not belong to the user who attempted to create the instance. |
| 400 | Invalid.InstanceId | The Instance dose not attached to a PrivatePool. | The instance and the private pool do not match. |
| 400 | MissingParameter.PackageType | The specified parameter "PackageType" can not be empty. | - |
| 400 | MissingParameter.PrivatePoolOptions.Ids | The specified parameter "PrivatePoolOptions.Ids" can not be empty. | - |
| 400 | MissingParameter.PrivatePoolOptions.Id | The specified parameter "PrivatePoolOptions.Id" can not be empty. | - |
| 400 | MissingParameter.InstanceCpuCoreCount | The specified parameter "InstanceCpuCoreCount" can not be empty. | - |
| 400 | MissingParameter.InstanceAmount | The specified parameter "InstanceAmount" can not be empty. | - |
| 400 | MissingParameter.InstanceCpuCoreCountOrInstanceAmount | The specified parameter "InstanceCpuCoreCount" and "InstanceAmount" must not be empty at the same time. | - |
| 400 | Invalid.TooManyPrivatePoolOptions.Ids | Too many PrivatePoolOptions.Ids in this request. | The number of specified private pool IDs exceeds the upper limit. |
| 400 | Invalid.TooManyZoneIds | Too many ZoneIds in the request. | The number of specified zone IDs exceeds the upper limit. |
| 400 | Invalid.TooManyInstanceTypes | Too many InstanceTypes in the request. | The number of specified instance types exceeds the upper limit. |
| 400 | Invalid.TooManyUnpaidPrivatePool | Too many PrivatePools create but still unpaid. | Multiple private pools are created but not paid. |
| 400 | Invalid.InstanceCpuCoreCountOrInstanceAmount | Both InstanceCpuCoreCount and InstanceAmount are provided. | The InstanceCpuCoreCount and InstanceAmount parameters cannot be both specified. |
| 400 | Invalid.PrivatePoolOptions.Ids | The specified parameter "PrivatePoolOptions.Ids" exist invalid element Id. | - |
| 400 | Invalid.PackageType | The specified parameter "PackageType" is invalid. | - |
| 400 | Invalid.PrivatePool.Purchase | The PrivatePool has already paid. | The private pool is already paid. |
| 400 | Invalid.AssuranceTimes.NotSupported | The value of AssuranceTimes is not supported. | The specified AssuranceTimes parameter is invalid. |
| 400 | Invalid.TooManyInstanceTypes | The specified parameter "InstanceType" should only has one item. | - |
| 400 | Invalid.PrivatePoolOptions.MatchCriteria | The specified parameter "PrivatePoolOptions.MatchCriteria" is invalid. | - |
| 400 | RepeatStartPrivatePool | PrivatePool has already been started. | The private pool is already started. |
| 400 | Invalid.PrivatePoolOptions.Id | The specified parameter "PrivatePoolOptions.Id" should be empty. | - |
| 400 | Invalid.InstanceId | Modify DedicatedHost Instance's attachment attributes is not supported. | - |
| 400 | Invalid.InstanceId | Modify Spot Instance's attachment attributes is not supported. | - |
| 400 | Invalid.InstanceId | Modify Classic Network Instance's attachment attributes is not supported. | - |
| 400 | Invalid.TimeSlot | The param time slot is invalid. | - |
| 400 | Invalid.EndTime | The specified parameter "EndTime" is not valid. | - |
| 400 | StartTime.NotNeed | The specified parameter "StartTime" should leave empty. | - |
| 400 | AccountForbidden.ProductCreationLimited | The commodity must be officially operated by Aliyun and in pay-as-you-go billing method. | - |
| 400 | RegionUnauthorized | There is no authority to create private pool in the specified region. | - |
| 400 | PriceNotFound | The price of your queried resource is not available now, please try other resources. | The price of the specified resource does not exist. Modify the parameter value and try again later. |
| 403 | Zone.NotOpen | The specified zone is not granted to you to buy resources yet. | You are not authorized to purchase resources in the specified zone. |
| 403 | InvalidResourceType.NotSupported | %s | - |
| 403 | OperationDenied.NoStock | The resource is out of stock in the specified zone. Please try other types, or choose other regions and zones. | The requested resources are unavailable in the specified zone. Try a different resource type or select a different region or zone. |
| 403 | InvalidInstanceType.NotSupported | The specified InstanceType is invalid. | - |
| 403 | Invalid.ZoneIds | At least one of the specified ZoneIds are invalid. | - |
| 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. |
| 404 | InvalidZoneId.NotFound | The specified zoneId does not exist. | The specified zone ID does not exist. |
| 404 | InvalidResourceGroup.NotFound | The ResourceGroup provided does not exist in our records. | The specified resource group does not exist. |
| 500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | An internal error has occurred. Try again later. |
| 500 | InternalError | The request processing has failed due to some unknown error. | An internal error has occurred. Try again later. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2021-07-29 | The Error code has changed | View Change Details |