Modifies the configurations of a serverless cluster.
Debugging
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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
polardb:ModifyDBClusterServerlessConf | Write |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBClusterId | string | Yes | The ID of the serverless cluster. | pc-bp10gr51qasnl**** |
ScaleMin | string | No | The minimum number of PCUs per node for scaling. Valid values: 1 PCU to 31 PCUs. | 1 |
ScaleMax | string | No | The maximum number of PCUs per node for scaling. Valid values: 1 PCU to 32 PCUs. | 10 |
ScaleRoNumMin | string | No | The minimum number of read-only nodes for scaling. Valid values: 0 to 15. | 1 |
ScaleRoNumMax | string | No | The maximum number of read-only nodes for scaling. Valid values: 0 to 15. | 2 |
AllowShutDown | string | No | Specifies whether to enable No-activity Suspension. Default value: false. Valid values:
| true |
SecondsUntilAutoPause | string | No | 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 |
ScaleApRoNumMin | string | No | The minimum number of stable AP read-only nodes. Valid values: 0 to 7. | 1 |
ScaleApRoNumMax | string | No | The maximum number of stable AP read-only nodes. Valid values: 0 to 7. | 1 |
PlannedStartTime | string | No | 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
2021-01-14T09:00:00Z , you can specify a point in time between 2021-01-14T09:00:00Z and 2021-01-15T09:00:00Z . | 2021-01-14T09:00:00Z |
PlannedEndTime | string | No | 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
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 |
FromTimeService | boolean | No | Specifies an immediate or scheduled task to modify parameters and restart the cluster. Valid values:
| false |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "5E71541A-6007-4DCC-A38A-F872C31FEB45",
"DBClusterId": "pc-bp10gr51qasnl****"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
404 | InvalidDBInstanceClass.NotFound | rw class code must be equal with hot replica | The specification of the secondary node must be the same as that of the primary node. |
404 | InvalidDBClusterId.Malformed | The 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 time | Summary of changes | Operation | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-09-25 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||||
| ||||||||||||||
2023-09-21 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||||
| ||||||||||||||
2023-04-24 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||||
|