Modifies cluster parameters and applies them to specified nodes.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ModifyDBClusterAndNodesParameters

The operation that you want to perform. Set the value to ModifyDBClusterAndNodesParameters.

DBClusterId String Yes pc-****************

The ID of the cluster.

DBNodeIds String No pi-****************,pi-**********,

The ID of the node. 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 this parameter is empty, the cluster parameters are modified.
Parameters String No {"wait_timeout":"86","innodb_old_blocks_time":"10"}

The JSON string for the parameter and its value.

ParameterGroupId String No pcpg-**************

The ID of the parameter template.

PlannedStartTime String No 2021-01-14T09:00:00Z

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.
PlannedEndTime String No 2021-01-14T09:30:00Z

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.
  • If you specify the PlannedStartTime parameter but do not specify a value for the PlannedEndTime parameter, the latest start time of the task is set to a value that is calculated by the value of the PlannedEndTime parameter + 30 minutes by default. 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.
FromTimeService Boolean No false

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

  • false
  • true

Response parameters

Parameter Type Example Description
RequestId String 9B7BFB11-C077-4FE3-B051-F69CEB******

The ID of the request.

Examples

Sample requests

http(s)://polardb.aliyuncs.com/?Action=ModifyDBClusterAndNodesParameters
&DBClusterId=pc-****************
&DBNodeIds=pi-****************,pi-**********,
&Parameters={"wait_timeout":"86","innodb_old_blocks_time":"10"}
&ParameterGroupId=pcpg-**************
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyDBClusterAndNodesParametersResponse>
    <RequestId>9B7BFB11-C077-4FE3-B051-F69CEB******</RequestId>
</ModifyDBClusterAndNodesParametersResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HttpCode Error code Error message Description
400 InvalidParameters.Format Specified parameters is not valid. The error message returned because a specified parameter is invalid.
400 InvalidDBType.Malformed The Specified DBType is not valid. The error message returned because the specified database type is invalid.
400 ParamCollationServerNotValid This param collation_server is not valid. The error message returned because the specified collation_server is invalid.
400 MinorVersionNotSupport Custins minor version does not support current action. The error message returned because the operation is not supported while the cluster is of the current minor version. Update the minor version to the latest.
400 ScheduleTaskExist The specified dbCluster already has a scheduled task. The error message returned because the specified instance already has a scheduled task.
404 InvalidDBCluster.NotFound The specified DBClusterId is not found. The error message returned because the specified cluster ID does not exist.
404 InvalidDBClusterId.NotFound The DBClusterId provided does not exist in our records. The error message returned because the specified DBClusterId does not exist in the current record.

For a list of error codes, visit the API Error Center.