All Products
Search

This Product

    PolarDB:ModifyDBClusterParameters

    Document Center

    PolarDB:ModifyDBClusterParameters

    Last Updated:Dec 11, 2025

    Modifies the parameters of a PolarDB cluster or applies an existing parameter template to a destination cluster.

    Operation description

    The parameter template feature in PolarDB lets you centrally manage parameters and apply them to your clusters. For more information, see Use parameter templates.

    Note

    The parameter template feature is available only for PolarDB for MySQL.

    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 None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DBClusterId

    string

    Yes

    The cluster ID.

    Note

    Call the DescribeDBClusters operation to view information about all clusters in the destination region, including cluster IDs.

    pc-**************
    Parameters

    string

    No

    A JSON string that consists of parameters and their values. The parameter values must be strings. For example: {"wait_timeout":"86","innodb_old_blocks_time":"10"}.

    Note

    • Call the DescribeDBClusterParameters operation to view the parameters of a PolarDB cluster.

    • This parameter is required if the destination cluster is a PolarDB for PostgreSQL or PolarDB for PostgreSQL (Oracle compatible) cluster.

    • If the destination cluster is a PolarDB for MySQL cluster, you must specify this parameter or the ParameterGroupId parameter.

    {"wait_timeout":"86","innodb_old_blocks_time":"10"}
    ParameterGroupId

    string

    No

    The ID of the parameter template.

    Note

    • Call the DescribeParameterGroups operation to view the ID of the parameter template.

    • You must specify this parameter or the Parameters parameter.

    • This parameter is supported only by PolarDB for MySQL.

    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 can be any point in time 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 in the range of 2021-01-14T09:00:00Z to 2021-01-15T09:00:00Z.

    • If you leave this parameter empty, the task is executed immediately.

    2022-04-28T14: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 later than the earliest start time.

    • If you specify PlannedStartTime but not this parameter, the latest time to start the task is PlannedStartTime + 30 minutes by default. 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.

    2022-04-28T14:30:00Z
    FromTimeService

    boolean

    No

    Specifies whether to immediately modify the parameters and restart the cluster. Valid values:

    • false (default): The modification is scheduled.

    • true: The modification is performed immediately.

    false

    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 response

    JSON format

    {
  "RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC"
}

    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.