ModifyDBClusterAndNodesParameters - PolarDB - Alibaba Cloud Documentation Center

Modifies cluster parameters and applies them to specified nodes.

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:ModifyDBClusterAndNodesParameters	Read	DBCluster acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	pc-****************
DBNodeIds	string	No	The node ID. You can set this parameter to modify the parameters of a specified node or of the cluster. Separate multiple node IDs with commas (,). Note If you do not specify this parameter, only the cluster parameters are modified.	pi-**************,pi-********,
Parameters	string	No	The JSON string for the parameter and its value.	{"wait_timeout":"86","innodb_old_blocks_time":"10"}
ParameterGroupId	string	No	The ID of the parameter template that is used for the instance.	pcpg-**************
PlannedStartTime	string	No	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 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
PlannedEndTime	string	No	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. By default, if you specify the `PlannedStartTime` parameter but do not specify the PlannedEndTime parameter, the latest start time of the task is set to a value that is calculated by using the following formula: `Value of the PlannedEndTime parameter + 30 minutes`. 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
FromTimeService	boolean	No	Specifies an immediate or scheduled task to modify parameters and restart the cluster. Default value: false. Valid values: false: runs the kernel upgrade task in a scheduled manner. true: immediately runs the kernel upgrade task.	false

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	9B7BFB11-C077-4FE3-B051-F69CEB******

Examples

Sample success responses

JSONformat

{
  "RequestId": "9B7BFB11-C077-4FE3-B051-F69CEB******"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameters.Format	Specified parameters is not valid.	The specified parameters are invalid.
400	InvalidDBType.Malformed	The Specified DBType is not valid.	The specified database type is invalid.
400	ParamCollationServerNotValid	This param collation_server is not valid.	The collation_server parameter is invalid.
400	MinorVersionNotSupport	Custins minor version does not support current action.	The current minor version does not support this feature. Please update to the latest version.
400	ScheduleTaskExist	The specified dbCluster already has a scheduled task.	The specified cluster already has a scheduled task.
400	ParamTypeException	Param is isClusterAvailable, not allow to change alone	The isClusterAvailable parameter cannot be separately modified.
400	ParamDynamicException	Conflicting parameters: %s	The value of the %s parameter conflicts with other values.
404	InvalidDBCluster.NotFound	The specified DBClusterId is not found.	The specified cluster ID does not exist.
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
404	InvalidDBNodeId.NotFound	The DBNodeId provided does not exist in our records.	-

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

Change history

Change time

Summary of changes

Operation

2023-09-12