备案控制台
文档
产品文档
输入文档关键字查找
首页 云原生数据库 PolarDB 开发参考 PolarDB MySQL版/PostgreSQL版API参考 API参考指南 API目录 集群管理 ModifyDBCluster - 修改集群功能配置

ModifyDBCluster - 修改集群功能配置

更新时间：
一键部署
产品详情
相关技术圈
我的收藏

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
DBClusterIdstring是

集群 ID。

说明 您可以调用 DescribeDBClusters 接口查看目标地域下所有的集群信息，包括集群 ID。
pc-*************
StandbyHAModestring否

集群的跨可用区自动切换模式，取值范围如下：

  • ON：开启跨可用区自动切换。
  • OFF：关闭跨可用区自动切换。
  • 0：开启客户演练。
ON
DataSyncModestring否

集群的跨可用区数据复制方式，取值范围如下：

  • AsyncSync：异步。
  • SemiSync：半同步。
AsynSync
FaultSimulateModestring否

集群的故障演练模拟场景。取值为 0，表示模拟主可用区故障。

说明
  • 当StandbyHAMode设置为 0 时，该参数才生效。
  • 模拟主可用区故障场景中，主可用区所有的计算节点均不可用，该场景的容灾切换是有损的。
    •
    		0
    StorageAutoScalestring否

    标准版集群是否开启存储自动扩容。取值范围如下：

    • Enable：开启存储自动扩容。
    • Disable：关闭存储自动扩容。
    		Enable
    CompressStoragestring否

    开启存储压缩。取值为 ON。

    		ON
    StorageUpperBoundlong否

    标准版集群存储自动扩容上限，单位：GB。

    说明 取值最大为 32000。
    		800

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

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

    返回参数

    名称类型描述示例值
    object

    Schema of Response

    RequestIdstring

    请求 ID。

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

    集群 ID。

    		pc-*************
    OrderIdstring

    生成的订单 ID。

    		2148126708*****

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code错误码错误信息描述
    400OperationDenied.CreateDBNodesWithStrictConsistencyOn3AZ cluster does not allow create db nodes.3AZ 集群不允许增加节点。
    400InvalidDBProxyClusterClass.MalformedThe specified parameter DBProxyClusterClass is not valid.指定的参数DBProxyClusterClass无效。
    400InvalidDBNodeNum.MalformedThe number of parameter DBNode.N is not valid.参数DBNode的数量无效
    400OperationDenied.ModifyDBNodeClassWithStrictConsistencyOn3AZ cluster does not allow modify db node class.3AZ 集群不允许变更 Logger 节点规格。
    400InvalidDowngradeDBNodeClass.LimitThe specified Downgrade DBNodeClass is limit on the MaxDiskSize.DBNodeClass降配被MaxDiskSize的限制。
    400InvalidEngine.UnsupportedThe specified Engine does not support this feature.指定的引擎不支持此功能
    400OperationDenied.ModifyProxyWithStrictConsistencyOn3AZ cluster does not allow modify proxy.3AZ 集群不允许变更数据库代理。
    400StandbyClusterTurnOnThe specified dbCluster already turn on hot standby cluster.指定的dbCluster已打开热备集群。
    403IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.当前数据库实例类型不支持此操作
    403IncorrectDBInstanceCurrent DB instance does not support this operation.当前数据库实例不支持此操作
    403OperationDenied.LockModeThe operation is not permitted due to lock of cluster.PolarDB集群当前锁定状态下不允许执行该操作。
    403OperationDenied.DBClusterStatusThe operation is not permitted due to status of cluster.PolarDB集群当前状态下不允许执行该操作。
    403OperationDenied.TempUpgradeDuringThis operation is not allowed during the temporary upgrade of the cluster.在集群的临时升级过程中，不允许执行此操作。
    403InvalidParam.PgDBNodeSpecThe specification PGO of DB nodes is incorrect.DB节点的规范PGO不正确。
    403InvalidParam.NoChangeNo change found未找到更改
    403OperationDenied.DBNodeClassThe target DB node class is invalid for SQL acceleration.目标DB节点类对于SQL加速无效。
    403OperationDenied.ReaderNumThe target reader node number is invalid for SQL acceleration.目标读取器节点号对于SQL加速无效。
    403InvalidParam.DBNodeNumThe number of DB nodes is incorrect.数据库节点的数量不正确。
    403OperationDenied.DBNodeRoleThe operation is not permitted due to the role of node.由于节点的角色，不允许该操作
    403OperationDenied.DeleteNodeThe senormal version cluster does not allow the deletion of ro nodes and standby nodes at the same time.senormal版本集群不允许同时删除ro节点和备用节点。
    403OperationDenied.EndpointDBNodeNumberThe operation is not permitted due to node number for Endpoint.该Endpoint不允许执行该操作。
    403OperationDenied.StandbyEqualSpecThe spec of standby must be equal to rw备用的规格必须为rw
    403OperationDenied.DeleteDBNodeNumberThe operation is not permitted due to the node number to delete.该节点不允许被删除。
    403OperationDenied.DbVersionThe operation is not permitted due to DbVersion.由于DB版本问题，不允许执行此操作。
    403OperationDenied.ClusterCategoryThe operation is not permitted due to cluster category.该集群不支持此产品系列。
    403OperationDenied.clusterSingleNodeLimitSingle-node instances are not supported and need to be upgraded to cluster version不支持单节点实例，需要将其升级到集群版本。
    403InvalidParam.CRACParamNodeNumThe CRAC nodes cannot exceed 8.CRAC节点不能超过8个。
    403InvalidParam.ECSESSDSTANDARDParamNodeNumThe ECSESSDSTANDARD nodes cannot exceed 8.ECESSDSTANDARD节点不能超过8个。
    404InvalidParamInvalid Parameter.-
    404InvalidEditTypeWrong upgrade type.升级类型错误。
    500InternalErrorThe request processing has failed due to some unknown error, exception or failure.由于某些未知错误、异常或失败，请求处理失败。

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

    变更历史

    变更时间变更内容概要操作
    2023-12-26OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更。
      删除错误码：400
      删除错误码：403
      删除错误码：404
      删除错误码：500
    入参OpenAPI 入参发生变更。
      新增入参：CompressStorage
    2023-09-19OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更。
      错误码 403 变更
      错误码 404 变更
      新增错误码：400
      新增错误码：500
    2023-08-03OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更。
      删除错误码：403
      删除错误码：404
    入参OpenAPI 入参发生变更。
      新增入参：StorageAutoScale
      新增入参：StorageUpperBound
    2023-07-19OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更。
      删除错误码：403
      删除错误码：404
    文档推荐
    • 本页导读 （0）
    文档反馈