ModifyDBCluster - 修改集群功能配置 - 云原生数据库 PolarDB

修改PolarDB MySQL集群的功能配置。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
polardb:ModifyDBCluster	update	DBCluster acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DbClusterId}	无	无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	集群 ID。说明您可以调用 DescribeDBClusters 接口查看目标地域下所有的集群信息，包括集群 ID。	pc-*************
StandbyHAMode	string	否	集群的跨可用区自动切换模式，取值范围如下： ON：开启跨可用区自动切换。 OFF：关闭跨可用区自动切换。	ON
DataSyncMode	string	否	集群的跨可用区数据复制方式，取值范围如下： AsyncSync：异步。 SemiSync：半同步。	AsynSync
FaultSimulateMode	string	否	集群的故障演练维度。取值范围如下： `0`或`FaultInjection`：主可用区维度故障演练。 `1`：节点维度故障演练。说明主可用区维度故障演练场景，主可用区所有的计算节点均不可用，该场景的容灾切换是有损的。节点维度故障演练场景，仅支持单个计算节点进行演练，通过`DBNodeCrashList`传入期望计算节点名。	0
StorageAutoScale	string	否	标准版集群是否开启存储自动扩容。取值范围如下： Enable：开启存储自动扩容。 Disable：关闭存储自动扩容。	Enable
CompressStorage	string	否	开启存储压缩。取值为 ON。	ON
StorageUpperBound	long	否	标准版集群存储自动扩容上限，单位：GB。说明取值最大为 32000。	800
DBNodeCrashList	string	否	演练节点实例名列表。说明节点维度的演练只支持单个节点，可用区维度的演练可不传该参数，或传入所有节点。	pi-rwxxx
FaultInjectionType	string	否	故障注入方式。取值范围如下： 0：基于`Crash SQL`的实例故障注入枚举值： CrashSQLInjection：CrashSQLInjection。	0
ImciAutoIndex	string	否	自动列存索引提速功能。取值范围如下： `ON`：开启。 `OFF`：关闭。说明仅支持 PolarDB MySQL 版集群。集群版本限制，请参见自动无感提速（AutoIndex）。	OFF

对于参数 StandbyHAMode、DataSyncMode、FaultSimulateMode 和 StorageAutoScale，每次调用只能设置一个。如设置了 StandbyHAMode 参数的值后，不支持再同时设置其它的请求参数的值。

说明当参数 StorageAutoScale 的值设置为 Enable 后，还需要设置集群存储自动扩容上限 StorageUpperBound 参数的值。

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	CD3FA5F3-FAF3-44CA-AFFF-BAF869******
DBClusterId	string	集群 ID。	pc-*************
OrderId	string	生成的订单 ID。	2148126708*****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	OperationDenied.CreateDBNodesWithStrictConsistencyOn	3AZ cluster does not allow create db nodes.	3AZ 集群不允许增加节点。
400	InvalidDBProxyClusterClass.Malformed	The specified parameter DBProxyClusterClass is not valid.	指定的参数DBProxyClusterClass无效。
400	InvalidDBNodeNum.Malformed	The number of parameter DBNode.N is not valid.	参数DBNode的数量无效
400	OperationDenied.ModifyDBNodeClassWithStrictConsistencyOn	3AZ cluster does not allow modify db node class.	3AZ 集群不允许变更 Logger 节点规格。
400	InvalidDowngradeDBNodeClass.Limit	The specified Downgrade DBNodeClass is limit on the MaxDiskSize.	DBNodeClass降配被MaxDiskSize的限制。
400	InvalidEngine.Unsupported	The specified Engine does not support this feature.	指定的引擎不支持此功能
400	OperationDenied.ModifyProxyWithStrictConsistencyOn	3AZ cluster does not allow modify proxy.	3AZ 集群不允许变更数据库代理。
400	StandbyClusterTurnOn	The specified dbCluster already turn on hot standby cluster.	指定的dbCluster已打开热备集群。
403	IncorrectDBInstanceType	Current DB instance type does not support this operation.	当前数据库实例类型不支持此操作
403	IncorrectDBInstance	Current DB instance does not support this operation.	当前数据库实例不支持此操作
403	OperationDenied.LockMode	The operation is not permitted due to lock of cluster.	PolarDB集群当前锁定状态下不允许执行该操作。
403	OperationDenied.DBClusterStatus	The operation is not permitted due to status of cluster.	PolarDB集群当前状态下不允许执行该操作。
403	OperationDenied.TempUpgradeDuring	This operation is not allowed during the temporary upgrade of the cluster.	在集群的临时升级过程中，不允许执行此操作。
403	InvalidParam.PgDBNodeSpec	The specification PGO of DB nodes is incorrect.	DB节点的规范PGO不正确。
403	InvalidParam.NoChange	No change found	未找到更改
403	OperationDenied.DBNodeClass	The target DB node class is invalid for SQL acceleration.	目标DB节点类对于SQL加速无效。
403	OperationDenied.ReaderNum	The target reader node number is invalid for SQL acceleration.	目标读取器节点号对于SQL加速无效。
403	InvalidParam.DBNodeNum	The number of DB nodes is incorrect.	数据库节点的数量不正确。
403	OperationDenied.DBNodeRole	The operation is not permitted due to the role of node.	由于节点的角色，不允许该操作
403	OperationDenied.DeleteNode	The senormal version cluster does not allow the deletion of ro nodes and standby nodes at the same time.	senormal版本集群不允许同时删除ro节点和备用节点。
403	OperationDenied.EndpointDBNodeNumber	The operation is not permitted due to node number for Endpoint.	该Endpoint不允许执行该操作。
403	OperationDenied.StandbyEqualSpec	The spec of standby must be equal to rw	备用的规格必须为rw
403	OperationDenied.DeleteDBNodeNumber	The operation is not permitted due to the node number to delete.	该节点不允许被删除。
403	OperationDenied.DbVersion	The operation is not permitted due to DbVersion.	由于DB版本问题，不允许执行此操作。
403	OperationDenied.ClusterCategory	The operation is not permitted due to cluster category.	该集群不支持此产品系列。
403	OperationDenied.clusterSingleNodeLimit	Single-node instances are not supported and need to be upgraded to cluster version	不支持单节点实例，需要将其升级到集群版本。
403	InvalidParam.CRACParamNodeNum	The CRAC nodes cannot exceed 8.	CRAC节点不能超过8个。
403	InvalidParam.ECSESSDSTANDARDParamNodeNum	The ECSESSDSTANDARD nodes cannot exceed 8.	ECESSDSTANDARD节点不能超过8个。
404	InvalidParam	Invalid Parameter.	-
404	InvalidEditType	Wrong upgrade type.	升级类型错误。
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	由于某些未知错误、异常或失败，请求处理失败。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-06-06	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2023-12-26	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2023-09-19	OpenAPI 错误码发生变更	查看变更详情
2023-08-03	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2023-07-19	OpenAPI 错误码发生变更	查看变更详情