All Products
Search
Document Center

PolarDB:ModifyDBNodeClass

Last Updated:Mar 01, 2024

Changes the node specifications of a PolarDB cluster.

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:ModifyDBNodeClassWRITE
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the cluster.

pc-*************
ModifyTypestringYes

The type of the configuration change. Valid values:

  • Upgrade
  • Downgrade
Upgrade
DBNodeTargetClassstringYes

The specifications of all nodes. For more information, see Specifications of computing nodes.

polar.mysql.x4.large
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 range from 2021-01-14T09:00:00Z to 2021-01-15T09:00:00Z.
  • If this parameter is empty, the upgrade task is immediately performed.
  • 2021-01-14T09:00:00Z
    PlannedEndTimestringNo

    The latest start time to run the task. 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 the value of the PlannedStartTime parameter.
  • If you specify the PlannedStartTime parameter but do not specify a value for the PlannedEndTime parameter, the latest start time of the task is set to a value that is calculated by the value of the PlannedEndTime parameter + 30 minutes by default. For example, if you set the PlannedStartTime parameter to 2021-01-14T09:00:00Z and you do not specify the PlannedEndTime parameter, the latest start time of the task is set to 2021-01-14T09:30:00Z.
  • 2021-01-14T09:30:00Z
    SubCategorystringNo

    The category of the cluster. Valid values:

    • normal_exclusive: dedicated
    • normal_general: genera-purpose
    normal_general

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

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

    The ID of the PolarDB cluster.

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

    The ID of the order.

    2035629******

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400ORDER.ARREARAGEYou must settle the overdue payments for your account before you can make a purchase.
    400InsufficientResourceCapacityThe resource is insufficient.Insufficient resources.
    403OperationDenied.RoEqualSpecmust exist at least ro class equal with rwThe number of read-only nodes must be equal to or greater than that of primary nodes.
    403OperationDenied.DBClusterStatusThe operation is not permitted due to status of cluster.The PolarDB cluster does not support this operation in the current state.

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

    Change history

    Change timeSummary of changesOperation
    2023-09-13The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
    2023-09-12The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: DBNodeType
    2023-06-12The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 403 change
      Added Error Codes: 400