ModifyDBClusterAndNodesParameters - PolarDB - Alibaba Cloud Documentation Center

Modifies the parameters of a cluster and applies the new values to specified nodes.

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:ModifyDBClusterAndNodesParameters

update

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	pc-**********
DBNodeIds	string	No	The ID of the node. Use this parameter to modify the parameters of the cluster and specific nodes. Separate multiple node IDs with a comma (,). Note If this parameter is empty, only the cluster parameters are modified.	pi-********,pi-********
Parameters	string	No	A JSON string that contains the parameters and their values.	{"wait_timeout":"86","innodb_old_blocks_time":"10"}
ParameterGroupId	string	No	The ID of the parameter template.	pcpg-**********
PlannedStartTime	string	No	The earliest time to start the scheduled task. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC. Note The start time must be within the next 24 hours. For example, if the current time is `2021-01-14T09:00:00Z`, you can set the start time to a value from `2021-01-14T09:00:00Z` to `2021-01-15T09:00:00Z`. If you leave this parameter empty, the task is executed immediately.	2021-01-14T09:00:00Z
PlannedEndTime	string	No	The latest time to start the scheduled task. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC. Note The latest start time must be at least 30 minutes after the earliest start time. If you set `PlannedStartTime` but not this parameter, the latest start time for the task is the value of `PlannedStartTime` plus 30 minutes. For example, if you set `PlannedStartTime` to `2021-01-14T09:00:00Z` and leave this parameter empty, the task starts no later than `2021-01-14T09:30:00Z`.	2021-01-14T09:30:00Z
FromTimeService	boolean	No	Specifies whether to immediately modify parameters and restart the cluster, or to schedule the task. Valid values: false (default): The task is scheduled. true: The task is immediately executed.	false
StandbyClusterIdListNeedToSync	string	No	The IDs of secondary clusters in a Global Database Network (GDN). The parameter settings are synchronized to these clusters.	gdn-********,gdn-********

Response elements

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

Examples

Success response

JSON format

{
  "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
400	ParamDynamicException	Conflicting parameters: %s	Please check if there are any identical prompts for the instance kernel parameters and the current modified parameters: %s
400	InvalidParameterGroupId.Malformed	The Specified parameter ParameterGroupId is not valid.	The specified ParameterGroupId parameter is invalid.
400	InvalidParameters.Malformed	The Specified parameters is not valid.	The specified parameter is invalid.
400	InvalidParameter.Malformed	Choose one of parameters and ParamGroupId.	You must select a ParamGroupId from parameters.
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.
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.