Purchases one or more storage capacity units (SCUs).
Operation description
Before you call this operation, make sure that you are familiar with the billing and pricing of SCUs. For more information, see Storage capacity units.
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The ID of the region in which to purchase the SCU. The purchased SCU can offset the bills of pay-as-you-go disks that reside in the specified region. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
Name | string | No | The name of the SCU. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with | ScuPurchaseDemo |
Capacity | integer | Yes | The capacity of the SCU. Unit: GiB. Valid values: 20, 40, 100, 200, 500, 1024, 2048, 5210, 10240, 20480, and 52100. | 20 |
Description | string | No | The description of the SCU. The description must be 2 to 256 characters in length and cannot start with | ScuPurchaseDemo |
StartTime | string | No | The time at which the SCU takes effect. It can be up to six months later than the time at which the SCU is created. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. This parameter is empty by default. If this parameter is left empty, the SCU takes effect immediately after it is created. | 2020-09-09T02:00:00Z |
Period | integer | No | The validity period of the SCU. Valid values:
Default value: 1. | 1 |
PeriodUnit | string | No | The unit of the validity period of the SCU. Valid values:
Default value: Month. | Month |
FromApp | string | No | The source of the request. The value is automatically set to OpenAPI and does not need to be changed. Default value: OpenAPI. | OpenAPI |
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 across requests. The | 123e4567-e89b-12d3-a456-426655440000 |
Amount | integer | No | The number of SCUs that you want to purchase. Valid values: 1 to 20. Default value: 1. | 1 |
Tag | object [] | No | The list of tags. | |
Key | string | No | The key of tag N to add to the SCU. N is the identifier of the tag key that you specify. Valid values of N: 1 to 20. The tag key cannot be an empty string. It can be up to 128 characters in length and cannot start with | TestKey |
Value | string | No | The value of tag N. N is the identifier of the tag value that you specify and corresponds to the N in | TestValue |
Response parameters
Examples
Sample success responses
JSON
format
{
"OrderId": "204135153880****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"StorageCapacityUnitIds": {
"StorageCapacityUnitId": [
"scu-bp67acfmxazb4p****"
]
}
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidParameter.Period | The specified Period is not valid. | The specified effective date is invalid. |
400 | MissingParameter.RegionId | The specified RegionId should not be null. | The RegionId parameter is required. |
400 | InvalidParameter.Name | The specified Name is invalid. | The specified Name parameter is invalid. |
400 | InvalidParameter.Capacity | The specified Capacity is invalid. | The specified Capacity value is out of range. |
400 | MissingParameter.Capacity | The specified Capacity should be not null. | The Capacity parameter is required. |
400 | InvalidParameter.PeriodUnit | The specified PeriodUnit is not supported. | The specified PeriodUnit parameter is invalid. |
400 | InvalidParameter.CapacityExceed | The specified Capacity exceeds the limitation of quota. | The specified Capacity value exceeds the maximum allowed value. |
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. |
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 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2023-07-28 | API Description Update. The Error code has changed | see changesets | ||||||||
|