PurchaseStorageCapacityUnit -

Description

Before you call this operation, make sure that you understand the billing methods and pricing of SCUs. For more information, see Storage capacity units.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	PurchaseStorageCapacityUnit	The operation that you want to perform. Set the value to PurchaseStorageCapacityUnit.
RegionId	String	Yes	cn-hangzhou	The ID of the region in which to purchase the SCU. After this parameter is specified, the purchased SCU can offset bills of only pay-as-you-go disks that reside in the specified region. You can call the DescribeRegions operation to query the most recent region list.
Name	String	No	ScuPurchaseDemo	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 `http://` or `https://`. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).
Capacity	Integer	Yes	20	The capacity of the SCU. Unit: GiB. Valid values: 20, 40, 100, 200, 500, 1024, 2048, 5210, 10240, 20480, and 52100.
Description	String	No	ScuPurchaseDemo	The description of the SCU. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.
StartTime	String	No	2020-09-09T02:00:00Z	The time when the SCU takes effect. It can be up to six months later than the time when 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.
Period	Integer	No	1	The validity period of the SCU. Valid values: Valid values when PeriodUnit is set to Month: 1, 2, 3, and 6. Valid values when PeriodUnit is set to Year: 1, 3, and 5. Default value: 1.
PeriodUnit	String	No	Month	The unit of the validity period of the SCU. Valid values: Month Year Default value: Month.
FromApp	String	No	OpenAPI	The source of the request. Default value: OpenAPI. This parameter does not need to be manually set.
ClientToken	String	No	123e4567-e89b-12d3-a456-426655440000	The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is 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.
Amount	Integer	No	1	The number of SCUs that you want to purchase. Valid values: 1 to 20. Default value: 1.
Tag.N.Key	String	No	TestKey	The key of tag N to add to the SCU. N indicates the number of tag keys that can be set. 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 `acs:` or `aliyun`. It cannot contain `http://` or `https://`.
Tag.N.Value	String	No	TestValue	The value of tag N to add to the SCU. N indicates the number of tag values that can be set and corresponds to the N of `Tag.N.Key`. Valid values: 1 to 20. The tag value can be an empty string. It can be up to 128 characters in length and cannot start with `acs:` or contain `http://` or `https://`.

Response parameters


Parameter	Type	Example	Description
OrderId	String	204135153880****	The ID of the order.
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	The ID of the request.
StorageCapacityUnitIds	Array of String	scu-bp67acfmxazb4p****	The ID of the SCU.

Examples

Sample requests

https://ecs.aliyuncs.com/?Action=PurchaseStorageCapacityUnit
&Capacity=20
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<PurchaseStorageCapacityUnitResponse>
    <OrderId>204135153880***</OrderId>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
    <StorageCapacityUnitIds>
        <StorageCapacityUnitId>scu-bp67acfmxazb4p****</StorageCapacityUnitId>
    </StorageCapacityUnitIds>
</PurchaseStorageCapacityUnitResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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 error message returned because the specified Period parameter is invalid.
400	MissingParameter.RegionId	The specified RegionId should not be null.	The error message returned because the required RegionId parameter is not specified.
400	InvalidParameter.Name	The specified Name is invalid.	The error message returned because the specified Name parameter is invalid.
400	InvalidParameter.Capacity	The specified Capacity is invalid.	The error message returned because the specified Capacity parameter is invalid.
400	MissingParameter.Capacity	The specified Capacity should be not null.	The error message returned because the required Capacity parameter is not specified.
400	InvalidParameter.PeriodUnit	The specified PeriodUnit is not supported.	The error message returned because the specified PeriodUnit parameter is invalid.
400	InvalidParameter.CapacityExceed	The specified Capacity exceeds the limitation of quota.	The error message returned because the specified Capacity parameter is invalid.
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 error message returned because the specified StartTime parameter is invalid.
400	InvalidStartTime.MalFormed	The specified StartTime is out of the permitted range.	The error message returned because the specified StartTime parameter is invalid.
500	InternalError	The request processing has failed due to some unknown error.	The error message returned because an internal error has occurred. Try again later.

For a list of error codes, visit the API Error Center.