ModifyDBClusterStorageSpace-阿里云帮助中心

This operation modifies the storage space for pay-as-you-go enterprise edition and standard edition clusters.

Operation description

Note

You cannot scale down the storage space of PolarDB for PostgreSQL clusters.

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:ModifyDBClusterStorageSpace

update

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	pc-*************
StorageSpace	integer	Yes	Specifies the new storage space. Unit: GB. Note For PolarDB for MySQL Standard Edition clusters, the storage space must be between 20 GB and 32,000 GB.	50
ClientToken	string	No	A client-generated token that ensures the idempotence of the request. The token must be unique for each request, case-sensitive, and a maximum of 64 ASCII characters in length.	6000170000591aed949d0f54a343f1a4233c1e7d1c5c******
PlannedStartTime	string	No	Specifies the earliest time to start the scheduled task. Specify the time in UTC in the `YYYY-MM-DDThh:mm:ssZ` format. Note This parameter takes effect only when `ModifyType` is set to `Upgrade`. The start time can be a point in time within the next 24 hours. For example, if the current time is `2021-01-14T09:00:00Z`, you can set the start time to a value that is between `2021-01-14T09:00:00Z` and `2021-01-15T09:00:00Z`. If you leave this parameter empty, the task runs immediately.	2021-01-14T09:00:00Z
PlannedEndTime	string	No	Specifies the latest time to start the scheduled task. Specify the time in UTC in the `YYYY-MM-DDThh:mm:ssZ` format. Note The latest start time must be at least 30 minutes later than the earliest start time. If you specify `PlannedStartTime` but not this parameter, the latest start time is `PlannedStartTime + 30 minutes` by default. For example, if you set `PlannedStartTime` to `2021-01-14T09:00:00Z` and leave this parameter empty, the task starts no later than `2021-01-14T09:30:00Z`.	2021-01-14T09:30:00Z
SubCategory	string	No	Specifies the subcategory of the cluster. Valid values: normal_exclusive: dedicated normal_general: general-purpose	normal_general
CloudProvider	string	No	Specifies the cloud provider of the instance.	ENS
AutoUseCoupon	boolean	No	Specifies whether to automatically use a coupon. Valid values: `true` (default): A coupon is automatically used. `false`: A coupon is not used.
PromotionCode	string	No	Specifies the promotion code. If you do not specify this parameter, the system uses the default coupon.	727xxxxxx934

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	685F028C-4FCD-407D-A559-072D63******
DBClusterId	string	The ID of the database cluster.	pc-*************
OrderId	string	The ID of the order.	2035629******

Examples

Success response

JSON format

{
  "RequestId": "685F028C-4FCD-407D-A559-072D63******",
  "DBClusterId": "pc-*************",
  "OrderId": "2035629******"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameters.Malformed	The Specified parameters is not valid.	The specified parameter is invalid.
403	OperationDenied.ModifyStorageSpace	This cluster edition does not support extension of storage capacity.	This cluster edition does not support extension of storage capacity.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.