文档首页/ 云数据库 GeminiDB/ API参考/ API v3(推荐)/ 实例管理/ 设置节点自动扩容策略 - QueryingConfigurationsofSecond-LevelMonitoring
更新时间:2025-11-12 GMT+08:00
分享

设置节点自动扩容策略 - QueryingConfigurationsofSecond-LevelMonitoring

功能介绍

设置节点自动扩容策略。

接口约束

该接口支持GeminiDB Cassandra数据库实例。

该接口支持按需和包周期实例。

包周期用户默认自动扣费。

账户需要有足够的余额,才可进行自动扩容。

实例状态非“normal”时,不允许设置节点自动扩容策略。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限策略和授权项

URI

PUT /v3/{project_id}/instances/{instance_id}/node-auto-expansion-policy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

租户在某一region下的project ID。获取方法请参见获取项目ID

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

instance_id

String

参数解释:

实例ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-token

String

参数解释:

用户Token。

通过调用IAM服务获取用户Token接口获取。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

switch_option

Boolean

参数解释:

节点扩容是否开启。

约束限制:

不涉及。

取值范围:

  • true:表示开启。
  • false:表示关闭。

默认取值:

不涉及。

overload_node_threshold

Integer

参数解释:

超负载节点比例。如当前实例3个节点,需要当2个节点满足阈值时触发扩容,因2÷3≈67%,可设置为67(向上取整)。

约束限制:

不涉及。

取值范围:

1~100的正整数。

默认取值:

不涉及。

cpu_threshold

Integer

参数解释:

触发节点自动扩容的CPU使用率。

约束限制:

不涉及。

取值范围:

1~100的正整数

默认取值:

默认为80。

mem_threshold

Integer

参数解释:

触发节点自动扩容的内存使用率。

约束限制:

不涉及。

取值范围:

1~100的正整数。

默认取值:

默认为80。

step

Integer

参数解释:

每次扩容的节点个数。

约束限制:

不涉及。

取值范围:

大等于1的正整数,最大不超过可扩容的节点上限。

默认取值:

默认为3。

node_limit

Integer

参数解释:

自动扩容所能达到的节点上限。

约束限制:

不涉及。

取值范围:

大等于1的正整数,最大不超过当前实例可扩容的节点上限。

默认取值:

默认为当前实例可扩容的节点上限。

响应参数

状态码: 200

请求示例

设置节点自动扩容策略

PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/auto-node-expansion-policy    
{    
  "switch_option" : "true", 
  "overload_node_threshold" : "50",  
  "cpu_threshold" : "80",  
  "mem_threshold" : "80",  
  "step" : "3",  
  "node_limit" : "10" 
 }

响应示例

无。

状态码

请参见状态码

错误码

请参见错误码

相关文档