All Products
Search
Document Center

PolarDB:ModifyDBClusterServerlessConf

Last Updated:Apr 01, 2024

Modifies the configurations of a serverless 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:ModifyDBClusterServerlessConfWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the serverless cluster.

pc-bp10gr51qasnl****
ScaleMinstringNo

The minimum number of PCUs per node for scaling. Valid values: 1 PCU to 31 PCUs.

1
ScaleMaxstringNo

The maximum number of PCUs per node for scaling. Valid values: 1 PCU to 32 PCUs.

10
ScaleRoNumMinstringNo

The minimum number of read-only nodes for scaling. Valid values: 0 to 15.

1
ScaleRoNumMaxstringNo

The maximum number of read-only nodes for scaling. Valid values: 0 to 15.

2
AllowShutDownstringNo

Specifies whether to enable No-activity Suspension. Default value: false. Valid values:

  • true
  • false
true
SecondsUntilAutoPausestringNo

The detection period for No-activity Suspension. Valid values: 5 to 1440. Unit: minutes. The detection duration must be a multiple of 5 minutes.

10
ScaleApRoNumMinstringNo

The minimum number of stable AP read-only nodes. Valid values: 0 to 7.

1
ScaleApRoNumMaxstringNo

The maximum number of stable AP read-only nodes. Valid values: 0 to 7.

1
PlannedStartTimestringNo

The earliest start time of the scheduled task for adding the read-only node. The scheduled task specifies that the task is run in the required period. Specify the time in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.

Note
  • The earliest start time of the scheduled 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 time between 2021-01-14T09:00:00Z and 2021-01-15T09:00:00Z.
  • If you leave this parameter empty, the task for adding the read-only node is immediately run by default.
  • 2021-01-14T09:00:00Z
    PlannedEndTimestringNo

    The latest start time for upgrading 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 the value of PlannedStartTime.
  • If you specify PlannedStartTime but do not specify PlannedEndTime, the latest start time of the task is set to a value that is calculated by using the following formula: PlannedEndTime value + 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 set to 2021-01-14T09:30:00Z.
  • 2021-01-14T09:30:00Z
    FromTimeServicebooleanNo

    Specifies an immediate or scheduled task to modify parameters and restart the cluster. Valid values:

    • false: scheduled task
    • true: immediate task
    false

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    5E71541A-6007-4DCC-A38A-F872C31FEB45
    DBClusterIdstring

    The ID of the serverless cluster.

    pc-bp10gr51qasnl****

    Examples

    Sample success responses

    JSONformat

    {
      "RequestId": "5E71541A-6007-4DCC-A38A-F872C31FEB45",
      "DBClusterId": "pc-bp10gr51qasnl****"
    }

    Error codes

    HTTP status codeError codeError messageDescription
    404InvalidDBInstanceClass.NotFoundrw class code must be equal with hot replicaThe specification of the secondary node must be the same as that of the primary node.
    404InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.The specified DBClusterId parameter is invalid.

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

    Change history

    Change timeSummary of changesOperation
    2023-09-25The 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: 404
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: ScaleApRoNumMin
      Added Input Parameters: ScaleApRoNumMax
    2023-09-21The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 404 change
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: PlannedStartTime
      Added Input Parameters: PlannedEndTime
      Added Input Parameters: FromTimeService
    2023-04-24The 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: 404
    Input ParametersThe request parameters of the API has changed.
      delete Input Parameters: ScaleApRoNumMin
      delete Input Parameters: ScaleApRoNumMax