All Products
Search

This Product

    PolarDB:ModifyDBCluster

    Document Center

    PolarDB:ModifyDBCluster

    Last Updated:Jul 01, 2026

    Modifies the feature configurations of a PolarDB for MySQL cluster.

    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

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    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-*************
    StandbyHAMode

    string

    No

    The cross-zone automatic switchover mode of the cluster. Valid values:

    • ON: enables cross-zone automatic switchover.

    • OFF: disables cross-zone automatic switchover.

    ON
    DataSyncMode

    string

    No

    The cross-zone data replication mode of the cluster. Valid values:

    • AsyncSync: asynchronous

    • SemiSync: semi-synchronous

    AsynSync
    FaultSimulateMode

    string

    No

    The dimension of the disaster recovery drill for the cluster. Valid values:

    • 0 or FaultInjection: primary zone-level disaster recovery drill.

    • 1: node-level disaster recovery drill.

    Note

    • In the primary zone-level disaster recovery drill scenario, all compute nodes in the primary zone become unavailable. The failover in this scenario causes service interruptions.

    • In the node-level disaster recovery drill scenario, only a single compute node is supported for the drill. Specify the desired compute node name by using DBNodeCrashList.

    0
    StorageAutoScale

    string

    No

    Specifies whether to enable automatic storage scaling for the Standard Edition cluster. Valid values:

    • Enable: enables automatic storage scaling.

    • Disable: disables automatic storage scaling.

    Enable
    CompressStorage

    string

    No

    Enables storage compression. Set the value to ON.

    ON
    StorageUpperBound

    integer

    No

    The upper limit for automatic storage scaling of the Standard Edition cluster. Unit: GB.

    Note

    The maximum value is 32000.

    800
    DBNodeCrashList

    string

    No

    The list of node instance names for the disaster recovery drill.

    Note

    Node-level drills support only a single node. For zone-level drills, you can leave this parameter empty or specify all nodes.

    pi-rwxxx
    FaultInjectionType

    string

    No

    The fault injection method. Valid values:

    • 0: instance fault injection based on Crash SQL

    Valid values:

    • CrashSQLInjection :

      CrashSQLInjection

    0
    ImciAutoIndex

    string

    No

    The automatic IMCI-based query acceleration feature. Valid values:

    • ON: enabled.

    • OFF: disabled.

    Note

    Valid values:

    • OFF :

      OFF

    • ON :

      ON

    OFF
    TableMeta

    string

    No

    The JSON string that contains the information about the databases and tables to be restored. The values of the database and table information are strings. Example: [ { "tables":[ { "name":"testtb", "type":"table", "newname":"testtb_restore" } ], "name":"testdb", "type":"db", "newname":"testdb_restore" } ].

    Note

    You can call the DescribeMetaList operation to query the names of databases and tables that can be restored, and then specify the information in the corresponding fields in the preceding example.

    [ { "tables":[ { "name":"testtb", "type":"table", "newname":"testtb_restore" } ], "name":"testdb", "type":"db", "newname":"testdb_restore" } ]
    ModifyRowCompression

    string

    No

    Modifies the row compression settings.

    OFF

    You can set only one of the following parameters per invoke: StandbyHAMode, DataSyncMode, FaultSimulateMode, and StorageAutoScale. For example, if you set the StandbyHAMode parameter, you cannot set any of the other request parameters at the same time.

    Note

    When you set StorageAutoScale to Enable, you must also set the StorageUpperBound parameter to specify the upper limit for automatic storage scaling of the cluster.

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The request ID.

    CD3FA5F3-FAF3-44CA-AFFF-BAF869******
    DBClusterId

    string

    The cluster ID.

    pc-*************
    OrderId

    string

    The order ID.

    2148126708*****

    Examples

    Success response

    JSON format

    {
  "RequestId": "CD3FA5F3-FAF3-44CA-AFFF-BAF869******",
  "DBClusterId": "pc-*************",
  "OrderId": "2148126708*****"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 OperationDenied.CreateDBNodesWithStrictConsistencyOn 3AZ cluster does not allow create db nodes. Nodes cannot be added for multi-zone clusters.
    400 InvalidDBProxyClusterClass.Malformed The specified parameter DBProxyClusterClass is not valid. The specified DBProxyClusterClass parameter is invalid.
    400 InvalidDBNodeNum.Malformed The number of parameter DBNode.N is not valid. The specified number of database nodes is invalid.
    400 OperationDenied.ModifyDBNodeClassWithStrictConsistencyOn 3AZ cluster does not allow modify db node class. The specification of the Logger node cannot be changed for multi-zone clusters.
    400 InvalidDowngradeDBNodeClass.Limit The specified Downgrade DBNodeClass is limit on the MaxDiskSize. The downgrade of DBNodeClass is limited by the MaxDiskSize parameter.
    400 InvalidEngine.Unsupported The specified Engine does not support this feature. This feature is not supported by the specified engine.
    400 OperationDenied.ModifyProxyWithStrictConsistencyOn 3AZ cluster does not allow modify proxy. The PolarProxy node cannot be changed for multi-zone clusters.
    400 StandbyClusterTurnOn The specified dbCluster already turn on hot standby cluster. Hot standby clusters are enabled for the specified dbCluster.
    500 InternalError The request processing has failed due to some unknown error, exception or failure. The request failed to be processed because unknown errors, exceptions, or failures have occurred.
    403 IncorrectDBInstanceType Current DB instance type does not support this operation. The current database instance type does not support this operation.
    403 IncorrectDBInstance Current DB instance does not support this operation. The current DB instance does not support this operation
    403 OperationDenied.LockMode The operation is not permitted due to lock of cluster. The PolarDB cluster is locked and does not support this operation.
    403 OperationDenied.DBClusterStatus The operation is not permitted due to status of cluster. The PolarDB cluster does not support this operation in the current state.
    403 OperationDenied.TempUpgradeDuring This operation is not allowed during the temporary upgrade of the cluster. This operation cannot be performed during the temporary upgrade of the cluster.
    403 InvalidParam.PgDBNodeSpec The specification PGO of DB nodes is incorrect. The PGO in the specification of the database cluster is incorrect.
    403 InvalidParam.NoChange No change found No changes are detected.
    403 OperationDenied.DBNodeClass The target DB node class is invalid for SQL acceleration. The class of the target database node cannot be used for SQL acceleration.
    403 OperationDenied.ReaderNum The target reader node number is invalid for SQL acceleration. The number of the target reader node cannot be used for SQL acceleration.
    403 InvalidParam.DBNodeNum The number of DB nodes is incorrect. The number of database nodes is incorrect.
    403 OperationDenied.DBNodeRole The operation is not permitted due to the role of node. This operation is not supported by the node role.
    403 OperationDenied.DeleteNode The senormal version cluster does not allow the deletion of ro nodes and standby nodes at the same time. In clusters of the senormal version, the read-only node and standby node cannot be deleted at the same time.
    403 OperationDenied.EndpointDBNodeNumber The operation is not permitted due to node number for Endpoint. This operation is not supported by the endpoint.
    403 OperationDenied.StandbyEqualSpec The spec of standby must be equal to rw The specification of the standby node must be rw.
    403 OperationDenied.DeleteDBNodeNumber The operation is not permitted due to the node number to delete. This node cannot be deleted.
    403 OperationDenied.DbVersion The operation is not permitted due to DbVersion. This operation is not supported by the database version.
    403 OperationDenied.ClusterCategory The operation is not permitted due to cluster category. This series is not supported by the cluster.
    403 OperationDenied.clusterSingleNodeLimit Single-node instances are not supported and need to be upgraded to cluster version Single-node instances are not supported. You must upgrade them to the Cluster Edition.
    403 InvalidParam.CRACParamNodeNum The CRAC nodes cannot exceed 8. The number of CRAC nodes cannot exceed eight.
    403 InvalidParam.ECSESSDSTANDARDParamNodeNum The ECSESSDSTANDARD nodes cannot exceed 8. The number of ECESSDSTANDARD nodes cannot exceed eight.
    404 InvalidParam Invalid Parameter.
    404 InvalidEditType Wrong upgrade type. The upgrade type is incorrect.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.