Purchases a storage plan.


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
ClientToken String No 6000170000591aed949d0f5********************

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value. Make sure that the value is unique among different requests. The value of this parameter is case-sensitive. The value can contain only ASCII characters and can be up to 64 characters in length.

Action String No CreateStoragePlan

The operation that you want to perform. Set the value to CreateStoragePlan.

Period String Yes Month

The unit of the subscription duration for the storage plan. Valid values:

  • Month: The subscription duration is measured in months.
  • Year: The subscription duration is measured in years.
UsedTime String Yes 3

The subscription duration of the storage plan.

  • If Period is set to Month, the value ranges from 1 to 9.
  • If Period is set to Year, the value can be 1, 2, 3, or 5.
StorageClass String Yes 500

The capacity of the storage plan. Unit: GB. Valid values: 50, 100, 200, 300, 500, 1000, 2000, 3000, 5000, 10000, 15000, 20000, 25000, 30000, 50000, 100000, and 200000

StorageType String Yes Mainland

The type of the storage plan. Valid values:

  • Mainland: The storage plan is used in regions in the Chinese mainland.
  • Overseas: The storage plan is used in Hong Kong (China) and regions outside China.

Response parameters

Parameter Type Example Description
RequestId String 69A85BAF-1089-4CDF-A82F-0A140F******

The ID of the request.

DBInstanceId String POLARDB-cn-**************

The ID of the instance.

OrderId String 2035638*******

The ID of the order.


Sample requests

&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK


JSON format

HTTP/1.1 200 OK

  "RequestId" : "69A85BAF-1089-4CDF-A82F-0A140F******",
  "DBInstanceId" : "POLARDB-cn-**************",
  "OrderId" : "2035638*******"

Error codes

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