Use ModifyDBClusterServerlessConf to modify serverless cluster configurations - PolarDB - Alibaba Cloud - PolarDB

Modifies the configuration of a serverless 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:ModifyDBClusterServerlessConf

update

*DBCluster

acs:polardb:*:{#accountId}:dbcluster/{#DbClusterId}

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 false	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 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
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 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
FromTimeService	boolean	No	Specifies an immediate or scheduled task to modify parameters and restart the cluster. Valid values: false: scheduled task true: immediate task	false
ServerlessRuleCpuShrinkThreshold	string	No	CPU downscale threshold	50
ServerlessRuleCpuEnlargeThreshold	string	No	CPU burst threshold	80
ServerlessRuleMode	string	No	Elastic sensitivity. Values: - normal: standard - flexible: sensitive	normal
TaskId	string	No	Asynchronous task ID.	143f8e9f-2566-4dff-be47-bed79f28fc78
CrontabJobId	string	No	Cycle policy ID.	143f8e9f-2566-4dff-be47-bed79f28fc78

Response elements

Element	Type	Description	Example
	object
DBClusterId	string	The ID of the serverless cluster.	pc-bp10gr51qasnl****
RequestId	string	The ID of the request.	5E71541A-6007-4DCC-A38A-F872C31FEB45

Examples

Success response

JSON format

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

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.