All Products
Search

This Product

    PolarDB:ModifyDBClusterParameters

    Document Center

    PolarDB:ModifyDBClusterParameters

    Last Updated:Jun 17, 2024

    Modifies the parameters of a specified PolarDB cluster or applies existing parameter templates to a specified cluster.

    Operation description

    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.

    **

    **Only PolarDB for MySQL clusters support parameter templates.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    polardb:ModifyDBClusterParametersWrite
    • dbcluster
      acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBClusterIdstringYes

    The ID of the cluster.

    Note You can call the DescribeDBClusters operation to query information about all clusters that are deployed in a specified region, such as the cluster ID.
    		pc-**************
    ParametersstringNo

    The JSON string that consists of parameters and values. The parameter values are strings, for example, {"wait_timeout":"86","innodb_old_blocks_time":"10"}.

    Note

    • You can call the DescribeDBClusterParameters operation to query the parameters of the PolarDB cluster.

    • This parameter is required for a PolarDB for Oracle or PolarDB for PostgreSQL cluster.

    • For PolarDB for MySQL clusters, you must specify this parameter or the ParameterGroupId parameter.

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

    The ID of the parameter template.

    Note

    • You can call the DescribeParameterGroups operation to query the parameter template ID.

    • You must specify this parameter or the Parameters parameter.

    • This parameter is valid only for a PolarDB for MySQL cluster.

    		pcpg-**************
    PlannedStartTimestringNo

    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.

    		2022-04-28T14:00:00Z
    PlannedEndTimestringNo

    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.

    • By default, if you specify the PlannedStartTime parameter but do not specify the PlannedEndTime parameter, the latest start time of the task is set to a value that is calculated by using the following formula: Value of the PlannedEndTime parameter + 30 minutes. 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.

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

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

    • false: scheduled task
    • true: immediate task
    		false

    Response parameters

    ParameterTypeDescriptionExample
    object

    1

    RequestIdstring

    The ID of the request.

    		C5D526E5-91B5-48B8-B980-FE07FF******

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidParameters.FormatSpecified parameters is not valid.The specified parameters are invalid.
    400InvalidParameters.FormatThe specified parameters are invalid.The specified parameters are invalid.
    400MinorVersionNotSupportCustins minor version does not support current action.The current minor version does not support this feature. Please update to the latest version.
    400ParamDynamicExceptionConflicting parameters: %sPlease check if there are any identical prompts for the instance kernel parameters and the current modified parameters: %s
    404InvalidDBClusterId.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-09-12The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      Error Codes 404 change
    2023-06-13The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 404
    2023-06-13The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 404
    2022-11-24The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      Added Error Codes: 404
    2021-03-08The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Added Error Codes: 400
    2021-03-08The request parameters of the API has changedsee changesets
    Change itemChange content
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: PlannedStartTime
      Added Input Parameters: PlannedEndTime
      Added Input Parameters: FromTimeService