All Products
Search

This Product

    PolarDB:ModifyDBClusterStorageSpace

    Document Center

    PolarDB:ModifyDBClusterStorageSpace

    Last Updated:Dec 11, 2025

    Modifies the storage space of pay-as-you-go Enterprise Edition and Standard Edition clusters.

    Operation description

    Note

    You cannot scale in the storage space of a PolarDB for PostgreSQL cluster.

    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 None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DBClusterId

    string

    Yes

    The ID of the cluster.

    pc-*************
    StorageSpace

    integer

    Yes

    The new storage space. Unit: GB.

    Note

    The storage space of a PolarDB for MySQL Standard Edition cluster ranges from 20 GB to 32,000 GB.

    50
    ClientToken

    string

    No

    A token that ensures the idempotence of the request. The token is generated by the client and must be unique among different requests. The token is case-sensitive and cannot exceed 64 ASCII characters in length.

    6000170000591aed949d0f54a343f1a4233c1e7d1c5c******
    PlannedStartTime

    string

    No

    The earliest time to start the scheduled task. The task runs within a specified time window. Specify the time in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.

    Note

    • This parameter is valid only when ModifyType is set to Upgrade.

    • The start time must be within the next 24 hours. For example, if the current time is 2021-01-14T09:00:00Z, you can set this parameter to a value from 2021-01-14T09:00:00Z to 2021-01-15T09:00:00Z.

    • If you leave this parameter empty, the configuration upgrade task is performed immediately.

    2021-01-14T09:00:00Z
    PlannedEndTime

    string

    No

    The latest time to start the scheduled task. Specify the time in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.

    Note

    • The latest start time must be at least 30 minutes later than the earliest start time.

    • If you set PlannedStartTime but not this parameter, the latest start time is 30 minutes after the PlannedStartTime. For example, if you set PlannedStartTime to 2021-01-14T09:00:00Z and leave this parameter empty, the task starts by 2021-01-14T09:30:00Z.

    2021-01-14T09:30:00Z
    SubCategory

    string

    No

    The subcategory of the cluster. Valid values:

    • normal_exclusive: Dedicated

    • normal_general: General-purpose

    normal_general
    CloudProvider

    string

    No

    ENS
    AutoUseCoupon

    boolean

    No

    PromotionCode

    string

    No

    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.