ModifyDBInstanceClass - 修改集群弹性配置

更新时间:
复制 MD 格式

调用ModifyDBInstanceClass接口修改集群的弹性配置。

接口说明

请确保在使用该接口前,已充分了解云数据库 ClickHouse 产品的收费方式和价格。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

clickhouse:ModifyDBInstanceClass

update

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

无 无

请求参数

名称

类型

必填

描述

示例值

RegionId

string

是

地域 ID。

cn-hangzhou

DBInstanceId

string

是

集群 ID。

cc-gs5j3sua77*******

ScaleMin

integer

否

serverless 弹性伸缩最小值。

8

ScaleMax

integer

否

serverless 弹性伸缩最大值。

32

NodeScaleMax

integer

否

serverless 节点弹性伸缩最大值。取值范围 4-32,且必须大于最小值

4

NodeScaleMin

integer

否

serverless 节点弹性伸缩最小值。取值范围 4-32

32

NodeCount

integer

否

节点个数,取值范围 2-16

2

StorageQuota

integer

否

存储预购量(GB)

100

StorageType

string

否

存储类型。

枚举值:

  • ESSD_L2 :

    增强型 SSD 云盘 ESSD PL2

  • ESSD_L3 :

    增强型 SSD 云盘 ESSD PL3

  • SSD :

    SSD 云盘

  • ESSD_L0 :

    增强型 SSD 云盘 ESSD PL0

  • ESSD_L1 :

    增强型 SSD 云盘 ESSD PL1

  • oss :

    对象存储 OSS

OSS

ComputingGroupId

string

否

计算组 ID。

cc-gs5j3sua77*******-clickhouse

AutoScaleConfig

object

否

自动水平弹性配置

Status

string

否

配置状态,disable 关闭,enable 开启

枚举值:

  • disable :

    关闭

  • enable :

    开启

enable

BurstNum

integer

否

可 burst 水平弹性数量

2

VSwitchInfos

array<object>

否

vSwitch 信息

object

否

vSwitch 信息

ZoneId

string

否

热池可用区

cn-beijing-XXX

VSwitchIds

array

否

可用区下的 vSwitchId

string

否

vSwitchId

vsw-XXXXX

返回参数

名称

类型

描述

示例值

object

返回参数详情。

RequestId

string

请求 ID。

xxx-xxx-xxx

Data

object

返回数据。

TaskId

integer

任务 ID。

10000****

ScaleMin

integer

serverless 弹性伸缩最小值。

2

ScaleMax

integer

serverless 弹性伸缩最大值。

32

DBInstanceID

integer

集群 ID。

cc-gs5j3sua77*******

DBInstanceName

string

集群名称。

cc-gs5j3sua77*******

ComputingGroupId

string

计算组 ID。

cc-gs5j3sua77*******-clickhouse

示例

正常返回示例

JSON格式

{
  "RequestId": "xxx-xxx-xxx",
  "Data": {
    "TaskId": 0,
    "ScaleMin": 2,
    "ScaleMax": 32,
    "DBInstanceID": 0,
    "DBInstanceName": "cc-gs5j3sua77*******",
    "ComputingGroupId": "cc-gs5j3sua77*******-clickhouse"
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidSpecification Specification parameter is not valid. 规格参数无效。
400 InvalidDBInstanceStatus The specified instance state does't support this operation. 实例状态不允许当前操作。
400 OperationDenied.OrderProcessing The operation is not permitted due to there is an order in processing of cluster. 存在未完成的订单,请稍后再试。
400 OperationDenied.NothingChanged The instance operation changes the specification, but the incoming specification is the same as the current specification without any changes. 实例操作变更配置,但传入配置与当前配置相同,没有任何改变。
400 ForbiddenRegisterAutoScaleConfig Can't register autoScale config
400 InvalidAutoScaleConfig The autoScale config is invalid, param error
400 UnsupportedAutoScaleZone ZoneId is null or the specified zone is not supported for autoScale

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

变更历史

更多信息,参考变更详情。