Modifies the parameters of a specified PolarDB cluster or applies existing parameter templates to a specified cluster.
PolarDB supports the parameter template feature to centrally manage clusters. You can configure a number of parameters at a time by using a parameter template and apply the template to a PolarDB cluster. For more information, see Use a parameter template.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ModifyDBClusterParameters | The operation that you want to perform. The operation that you want to perform. Set this parameter to ModifyDBClusterParameters. |
DBClusterId | String | Yes | pc-************** | The ID of the cluster. Note You can call the DescribeDBClusters operation to query information about all your PolarDB clusters that are deployed in a specified region. The returned information includes the ID of each cluster. |
Parameters | String | No | {"wait_timeout":"86","innodb_old_blocks_time":"10"} | The JSON string that consists of parameters and values. The parameter values are strings, for example, Note
|
ParameterGroupId | String | No | pcpg-************** | The ID of the parameter template. Note
|
PlannedStartTime | String | No | 2022-04-28T14:00:00Z | The earliest time to upgrade the specifications within the scheduled time period. Specify the time in the Note
|
PlannedEndTime | String | No | 2022-04-28T14:30:00Z | The lastest time to upgrade the specifications within the scheduled time period. Specify the time in the Note
|
FromTimeService | Boolean | No | false | Specifies an immediate or scheduled task to modify parameters and restart the cluster. Default value: false. Valid values:
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | C5D526E5-91B5-48B8-B980-FE07FF****** | The ID of the request. |
Examples
Sample requests
http(s)://polardb.aliyuncs.com/?Action=ModifyDBClusterParameters
&DBClusterId=pc-**************
&<Common request parameters>
Sample responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<ModifyDBClusterParametersResponse>
<RequestId>C5D526E5-91B5-48B8-B980-FE07FF******</RequestId>
</ModifyDBClusterParametersResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "C5D526E5-91B5-48B8-B980-FE07FF******"
}
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 | InvalidParameters.Format | The specified parameters are invalid. | The error message returned because the specified parameters are 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. |
For a list of error codes, visit the API Error Center.