Modifies the configurations of a PolarDB for MySQL cluster.
Debugging
Authorization information
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 PolarDB clusters that are deployed in a specified region, such as cluster IDs.
| pc-************* |
StandbyHAMode | string | No | Specifies whether to enable cross-zone automatic switchover. Valid values:
| ON |
DataSyncMode | string | No | The method used to replicate data across zones. Valid values:
| AsynSync |
FaultSimulateMode | string | No | The level of the disaster recovery drill. Valid values:
Note
| 0 |
StorageAutoScale | string | No | Specifies whether to enable automatic storage scaling. This parameter is available only for Standard Edition clusters. Valid values:
| Enable |
CompressStorage | string | No | Specifies whether to enable storage compression. Set the value to ON. | ON |
StorageUpperBound | long | No | The maximum storage capacity of the cluster of Standard Edition in automatic scaling. Unit: GB. Note
The maximum value of this parameter is 32000.
| 800 |
DBNodeCrashList | string | No | The list of nodes for the drill. Note
You can specify only one node for a node-level disaster recovery drill. For a primary zone-level disaster recovery drill, you can either choose not to specify this parameter or specify all nodes.
| pi-rwxxx |
FaultInjectionType | string | No | The fault injection method. Valid values:
| 0 |
You can specify only one of the following parameters: StandbyHAMode, DataSyncMode, FaultSimulateMode, and StorageAutoScale. For example, if you specify the StandbyHAMode parameter, you cannot specify another three parameters.
Response parameters
Examples
Sample success responses
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. |
403 | IncorrectDBInstanceType | Current DB 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. |
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. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-06-06 | The Error code has changed. The request parameters of the API has changed | View Change Details |
2023-12-26 | The Error code has changed. The request parameters of the API has changed | View Change Details |
2023-09-19 | The Error code has changed | View Change Details |
2023-08-03 | The Error code has changed. The request parameters of the API has changed | View Change Details |
2023-07-19 | The Error code has changed | View Change Details |