All Products
Search
Document Center

PolarDB:CreateStoragePlan

Last Updated:Oct 10, 2024

Purchases a storage plan.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
polardb:CreateStoragePlancreate
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClientTokenstringNo

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 token can only contain ASCII characters and cannot exceed 64 characters in length.

6000170000591aed949d0f5********************
PeriodstringYes

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

  • Month
  • Year
Month
UsedTimestringYes

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.
3
StorageClassstringYes

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

500
StorageTypestringYes

The type of the storage plan. Valid values:

  • Mainland: The storage plan is used inside the Chinese mainland.
  • Overseas: The storage plan is used outside the Chinese mainland.
Mainland

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

69A85BAF-1089-4CDF-A82F-0A140F******
DBInstanceIdstring

The instance ID.

POLARDB-cn-**************
OrderIdstring

The ID of the order.

2035638*******

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InvalidStorageUsedTime.MalformedThe UsedTime is not valid.The specified usedTime parameter is invalid.
400MissParameter.StorageUsedTimeThe StoragePeriod is needed.You must specify the storage period.
400MissParameter.StoragePeriodThe StoragePeriod is needed.You must specify the storage period.
400MissParameter.StorageClassThe StorageClass is needed.You must specify the storage specifications.
400MissParameter.StorageTypeThe StorageType is needed.You must specify the storage type.
400InvalidStorageClass.MalformedThe Specified StorageClass is not valid.The specified StorageClass parameter is invalid.

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

Change history

Change timeSummary of changesOperation
2023-09-12The Error code has changedView Change Details