Update PolarDB Cluster Parameters via ModifyDBClusterParameters API - PolarDB - Alibaba Cloud - PolarDB

Operation description

PolarDB provides the parameter template feature. You can use parameter templates to centrally manage parameters and quickly apply them to clusters. For more information, see Use parameter templates.

Note

Currently, only PolarDB for MySQL supports the parameter template feature.

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

update

*dbcluster

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID. Note You can call the DescribeDBClusters operation to query information about all clusters in the specified region, including cluster IDs.	pc-**************
Parameters	string	No	A JSON string that consists of parameters and their values. Parameter values are of the STRING type. Example: `{"wait_timeout":"86","innodb_old_blocks_time":"10"}`. Note You can call the DescribeDBClusterParameters operation to query the parameters of a PolarDB cluster. If the cluster runs PolarDB for PostgreSQL or PolarDB for PostgreSQL (Compatible with Oracle), this parameter is required. If the cluster runs PolarDB for MySQL, you must specify either this parameter or the `ParameterGroupId` parameter.	{"wait_timeout":"86","innodb_old_blocks_time":"10"}
ParameterGroupId	string	No	The parameter template ID. Note You can call the DescribeParameterGroups operation to query the parameter template ID. You must specify either this parameter or the `Parameters` parameter. Only PolarDB for MySQL supports this parameter.	pcpg-**************
PlannedStartTime	string	No	The earliest time to start running the scheduled task within the specified time range. The time is in the `YYYY-MM-DDThh:mm:ssZ` format (UTC). Note The start time must be within the next 24 hours. For example, if the current time is `2021-01-14T09:00:00Z`, the start time can range from `2021-01-14T09:00:00Z` to `2021-01-15T09:00:00Z`. If this parameter is left empty, the task is immediately executed.	2022-04-28T14:00:00Z
PlannedEndTime	string	No	The latest time to start running the scheduled task. The time is in the `YYYY-MM-DDThh:mm:ssZ` format (UTC). Note The latest time must be at least 30 minutes later than the start time. If you specify `PlannedStartTime` but do not specify this parameter, the latest time defaults to `start time + 30 minutes`. For example, if `PlannedStartTime` is set to `2021-01-14T09:00:00Z` and this parameter is left empty, the task starts no later than `2021-01-14T09:30:00Z`.	2022-04-28T14:30:00Z
FromTimeService	boolean	No	Specifies whether to immediately or schedule the parameter modification and cluster restart. Valid values: false (default): Scheduled execution. true: Immediate execution.	false
ClearBinlog	boolean	No	Specifies whether to clear binlogs. This parameter takes effect only when binlog is disabled.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	C5D526E5-91B5-48B8-B980-FE07FF******

Examples

Success response

JSON format

{
  "RequestId": "C5D526E5-91B5-48B8-B980-FE07FF******"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameters.Format	Specified parameters is not valid.	The specified parameters are 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	ParamDynamicException	Conflicting parameters: %s	Please check if there are any identical prompts for the instance kernel parameters and the current modified parameters: %s
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	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
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.