CreateStoragePlan - PolarDB - Alibaba Cloud Documentation Center

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardb:CreateStoragePlan

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	A client token to ensure the idempotence of the request. Generate this token on your client. The token must be unique across different requests. It is case-sensitive and can contain up to 64 ASCII characters.	6000170000591aed949d0f5********************
Period	string	Yes	The unit of the subscription duration for the storage plan. Valid values: Month Year	Month
UsedTime	string	Yes	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 valid values are 1, 2, 3, and 5.	3
StorageClass	string	Yes	The capacity of the storage plan, in GB. Valid values: 50, 100, 200, 300, 500, 1,000, 2,000, 3,000, 5,000, 10,000, 15,000, 20,000, 25,000, 30,000, 50,000, 100,000, and 200,000.	500
StorageType	string	Yes	The type of the storage plan. Valid values: Mainland: For use in the Chinese mainland. Overseas: For use in China (Hong Kong) and regions outside China.	Mainland

Response elements

Element	Type	Description	Example
	object	Response schema
RequestId	string	The request ID.	69A85BAF-1089-4CDF-A82F-0A140F******
DBInstanceId	string	The instance ID.	POLARDB-cn-**************
OrderId	string	The order ID.	2035638*******

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStorageUsedTime.Malformed	The UsedTime is not valid.	The specified usedTime parameter is invalid.
400	MissParameter.StorageUsedTime	The StoragePeriod is needed.	You must specify the storage period.
400	MissParameter.StoragePeriod	The StoragePeriod is needed.	You must specify the storage period.
400	MissParameter.StorageClass	The StorageClass is needed.	You must specify the storage specifications.
400	MissParameter.StorageType	The StorageType is needed.	You must specify the storage type.
400	InvalidStorageClass.Malformed	The Specified StorageClass is not valid.	The specified StorageClass parameter is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.