ModifyDBCluster_云数据库 PolarDB_API文档-阿里云OpenAPI开发者门户

流控信息

请求速率为200/60(s)。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

polardb:ModifyDBCluster	Update	DBCluster acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DbClusterId}	无	无

请求参数

字段名称	字段详情
DBClusterIdstring	集群 ID。展开详情示例值:pc-*************参考取值来源: CreateDBCluster ModifyDBClusterArch DescribeDBClusters RestartDBLink EnableDBClusterServerless TransformDBClusterPayType DisableDBClusterServerless
StandbyHAModestring	集群的跨可用区自动切换模式，取值范围如下：展开详情示例值:ON
DataSyncModestring	集群的跨可用区数据复制方式，取值范围如下：展开详情示例值:AsynSync
FaultSimulateModestring	集群的故障演练维度。取值范围如下：展开详情示例值:0枚举值:FaultInjectToPrimaryAzFaultInjectToDbNodeFaultInjection01
StorageAutoScalestring	标准版集群是否开启存储自动扩容。取值范围如下：展开详情示例值:Enable枚举值:EnableDisable
CompressStoragestring	开启存储压缩。取值为 ON。示例值:ON枚举值:
StorageUpperBoundinteger<int64>	标准版集群存储自动扩容上限，单位：GB。展开详情注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:800取值 <= 64000
DBNodeCrashListstring	演练节点实例名列表。展开详情示例值:pi-rwxxx
FaultInjectionTypestring	故障注入方式。取值范围如下：展开详情示例值:0枚举值:CrashSQLInjection
ImciAutoIndexstring	自动列存索引提速功能。取值范围如下：展开详情示例值:OFF枚举值:OFFON
TableMetastring
ModifyRowCompressionstring

请求说明

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

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

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:CD3FA5F3-FAF3-44CA-AFFF-BAF869******
DBClusterIdstring	集群 ID。示例值:pc-*************
OrderIdstring	生成的订单 ID。示例值:2148126708*****

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	OperationDenied.CreateDBNodesWithStrictConsistencyOn	3AZ cluster does not allow create db nodes.	诊断
400	InvalidDBProxyClusterClass.Malformed	The specified parameter DBProxyClusterClass is not valid.	诊断
400	InvalidDBNodeNum.Malformed	The number of parameter DBNode.N is not valid.	诊断
400	OperationDenied.ModifyDBNodeClassWithStrictConsistencyOn	3AZ cluster does not allow modify db node class.	诊断
400	InvalidDowngradeDBNodeClass.Limit	The specified Downgrade DBNodeClass is limit on the MaxDiskSize.	诊断
400	InvalidEngine.Unsupported	The specified Engine does not support this feature.	诊断
400	OperationDenied.ModifyProxyWithStrictConsistencyOn	3AZ cluster does not allow modify proxy.	诊断
400	StandbyClusterTurnOn	The specified dbCluster already turn on hot standby cluster.	诊断
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.	诊断
403	OperationDenied.DBClusterStatus	The operation is not permitted due to status of cluster.	诊断
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.	诊断
403	InvalidParam.NoChange	No change found	诊断
403	OperationDenied.DBNodeClass	The target DB node class is invalid for SQL acceleration.	诊断
403	OperationDenied.ReaderNum	The target reader node number is invalid for SQL acceleration.	诊断
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.	诊断
403	OperationDenied.EndpointDBNodeNumber	The operation is not permitted due to node number for Endpoint.	诊断
403	OperationDenied.StandbyEqualSpec	The spec of standby must be equal to 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.	诊断
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.	诊断
403	InvalidParam.ECSESSDSTANDARDParamNodeNum	The ECSESSDSTANDARD nodes cannot exceed 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.	诊断

变更历史

	变更时间	变更内容概要	操作
	2025-03-13	变更请求参数FaultSimulateMode 变更请求参数FaultInjectionType
	2025-01-09	新增请求参数TableMeta 新增请求参数ModifyRowCompression
	2024-10-25	新增请求参数ImciAutoIndex
	2024-06-06	新增请求参数DBNodeCrashList 新增请求参数FaultInjectionType
	2023-12-26	新增请求参数CompressStorage
	2023-09-19	新增错误码400 变更错误码403 变更错误码404 新增错误码500 变更请求参数StorageUpperBound

1
2
10 条/页