All Products
Search

This Product

    PolarDB:ModifyDBClusterAndNodesParameters

    Document Center

    PolarDB:ModifyDBClusterAndNodesParameters

    Last Updated:Apr 25, 2024

    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.

    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:ModifyDBClusterAndNodesParametersWrite
    • DBCluster
      acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBClusterIdstringYes

    The cluster ID.

    		pc-****************
    DBNodeIdsstringNo

    The node ID. 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 you do not specify this parameter, only the cluster parameters are modified.
    		pi-****************,pi-**********,
    ParametersstringNo

    The JSON string for the parameter and its value.

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

    The ID of the parameter template that is used for the instance.

    		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.

    		2021-01-14T09: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.

    		2021-01-14T09:30:00Z
    FromTimeServicebooleanNo

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

    • false: runs the kernel upgrade task in a scheduled manner.
    • true: immediately runs the kernel upgrade task.
    		false

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

    		9B7BFB11-C077-4FE3-B051-F69CEB******

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidParameters.FormatSpecified parameters is not valid.The specified parameters are invalid.
    400InvalidDBType.MalformedThe Specified DBType is not valid.The specified database type is invalid.
    400ParamCollationServerNotValidThis param collation_server is not valid.The collation_server parameter is invalid.
    400MinorVersionNotSupportCustins minor version does not support current action.The current minor version does not support this feature. Please update to the latest version.
    400ScheduleTaskExistThe specified dbCluster already has a scheduled task.The specified cluster already has a scheduled task.
    400ParamTypeExceptionParam is isClusterAvailable, not allow to change aloneThe isClusterAvailable parameter cannot be separately modified.
    400ParamDynamicExceptionConflicting parameters: %sPlease check if there are any identical prompts for the instance kernel parameters and the current modified parameters: %s
    400InvalidParameterGroupId.MalformedThe Specified parameter ParameterGroupId is not valid.The specified ParameterGroupId parameter is invalid.
    400InvalidParameters.MalformedThe Specified parameters is not valid.The specified parameter is invalid.
    400InvalidParameter.MalformedChoose one of parameters and ParamGroupId.You must select a ParamGroupId from parameters.
    404InvalidDBCluster.NotFoundThe specified DBClusterId is not found.The specified cluster ID does not exist.
    404InvalidDBClusterId.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.
    404InvalidDBNodeId.NotFoundThe DBNodeId provided does not exist in our records.-
    404InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.The specified DBClusterId parameter is invalid.

    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.
      Error Codes 400 change
      Error Codes 404 change
    2022-07-13The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      Error Codes 404 change
    2022-02-24The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 404
      Added Error Codes: 400
    2022-02-24The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 404
    2022-02-24Add Operationsee changesets
    2022-02-24The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 404
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: PlannedStartTime
      Added Input Parameters: PlannedEndTime
      Added Input Parameters: FromTimeService