All Products
Search

This Product

    PolarDB:ModifyDBClusterStorageSpace

    Document Center

    PolarDB:ModifyDBClusterStorageSpace

    Last Updated:Jun 17, 2024

    Changes the storage capacity of a pay-as-you-go cluster of Enterprise Edition or a cluster of Standard Edition.

    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:ModifyDBClusterStorageSpaceWrite
    • DBCluster
      acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBClusterIdstringYes

    The cluster ID.

    		pc-*************
    StorageSpacelongYes

    The storage capacity that you can select when you change the cluster. Unit: GB.

    Note You can set this parameter for PolarDB for MySQL clusters of Standard Edition to a value that ranges from 20 to 32000.
    		50
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length. The token is case-sensitive.

    		6000170000591aed949d0f54a343f1a4233c1e7d1c5c******
    PlannedStartTimestringNo

    The earliest time to upgrade the specifications within the scheduled time period. Specify the time in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.

    Note
  • This parameter takes effect only when ModifyType is set to Upgrade.
  • The earliest start time of the task 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 specify a point in the time that ranges from 2021-01-14T09:00:00Z to 2021-01-15T09:00:00Z.
  • If this parameter is left empty, the upgrade task is immediately performed.
    •
    		2021-01-14T09:00:00Z
    PlannedEndTimestringNo

    The latest time to upgrade the specifications within the scheduled time period. Specify the time in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.

    Note
  • The value of this parameter must be at least 30 minutes later than PlannedStartTime.
  • By default, if you specify PlannedStartTime but do not specify PlannedEndTime, the latest start time of the task is set to PlannedEndTime + 30 minutes. For example, if you set PlannedStartTime to 2021-01-14T09:00:00Z and you do not specify PlannedEndTime, the latest start time of the task is 2021-01-14T09:30:00Z.
    •
    		2021-01-14T09:30:00Z
    SubCategorystringNo

    The category of the cluster. Default value: ON. Valid values:

    • normal_exclusive: dedicated
    • normal_general: general-purpose
    		normal_general

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

    		685F028C-4FCD-407D-A559-072D63******
    DBClusterIdstring

    The cluster ID.

    		pc-*************
    OrderIdstring

    The order ID.

    		2035629******

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidParameters.MalformedThe Specified parameters is not valid.The specified parameter is invalid.
    403OperationDenied.ModifyStorageSpaceThis cluster edition does not support extension of storage capacity.This cluster edition does not support extension of storage capacity.

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

    Change history

    Change timeSummary of changesOperation
    2023-09-12The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 403
      Added Error Codes: 400
    2023-08-22The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 403