文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 实例管理/ 设置磁盘自动扩容策略
更新时间：2024-12-02 GMT+08:00
查看PDF
分享

设置磁盘自动扩容策略

功能介绍

设置磁盘自动扩容策略。

接口约束

  • 该接口支持GeminiDB Cassandra和GeminiDB Redis数据库实例。
  • 该接口支持按需和包周期实例。
  • 包周期用户默认自动扣费。
  • 账户需要有足够的余额，才可进行自动扩容。
  • 实例状态非“normal”时，不允许设置磁盘自动扩容策略。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

PUT https://{Endpoint}/v3/{project_id}/instances/disk-auto-expansion

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户token。
表3 请求Body参数

参数

是否必选

参数类型

描述

instance_ids

是

Array of strings

设置磁盘自动扩容的实例组ID。最大支持50个实例。

switch_option

否

String

自动扩容开关。

  • “on”，表示开启磁盘自动扩容策略。
  • “off”，表示关闭磁盘自动扩容策略。

默认值为“on”。

policy

是

Array of diskAutoExpansionPolicy

磁盘自动扩容策略。
表4 diskAutoExpansionPolicy

参数

是否必选

参数类型

描述

threshold

否

Integer

触发自动扩容阈值。

  • GeminiDB Cassandra
    • 只支持输入80、85和90。
    • 默认阈值为90，即当已使用存储空间达到总存储空间的90%或者可用空间小于10GB时就会触发扩容。
  • GeminiDB Redis
    • 只支持输入60、65、70、75、80、85和90。
    • 默认阈值为80，即当已使用存储空间达到总存储空间的80%时就会触发扩容。

step

否

Integer

扩容步长（s%）。

  • GeminiDB Cassandra
    • 默认为10，支持输入10、15和20。
    • 当触发自动扩容的时候，自动扩容当前存储空间的s%。
  • GeminiDB Redis
    • 默认为20，支持输入10、15和20。
    • 当磁盘满(磁盘使用率 > 98%)时。磁盘的总容量<600G，下一次自动扩容到当前磁盘容量使用率(已使用/总量)<85%；磁盘的总容量≥600G，下一次自动扩容到当前总容量+90G以上。
说明：
  • GeminiDB Cassandra
    • 非10倍数向上取整。
    • 小数点后四舍五入，默认一次最小100GB。
  • GeminiDB Redis
    • 小数点后四舍五入，默认一次最小1GB。
  • 账户余额不足时，会导致包年/包月实例扩容失败。

size

否

Integer

实例通过自动扩容所能达到的存储空间上限，单位：GB。

  • GeminiDB Cassandra
    • 存储空间的上限需大于等于实例当前存储容量的100GB，且最大上限不能超过实例当前规格支持的最大存储容量。
    • 批量自动扩容时，不支持自定义存储自动扩容上限，默认扩容至所选实例对应的最大存储空间。
  • GeminiDB Redis
    • 自动扩容时，不支持自定义存储自动扩容上限，默认扩容至所选实例对应的最大存储空间。

响应参数

状态码：204

无响应参数。

请求示例

  • 开启磁盘自动扩容策略
    • URI样例 
      PUT https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/disk-auto-expansion
    • 开启磁盘自动扩容策略，设置自动扩容阈值为90，扩容步长为10%，通过自动扩容所能达到的存储空间上限为600GB 
      { 
  "instance_ids" : [ "93e4b3eda14349b1b870f72829bc3b9bin06" ], 
  "policy" : { 
    "threshold" : 90, 
    "step" : 10, 
    "size" : 600 
  } 
}
  • 关闭磁盘自动扩容策略
    • URI样例 
      PUT https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/disk-auto-expansion
    • 关闭磁盘自动扩容策略 
      {
    "instance_ids": [
        "93e4b3eda14349b1b870f72829bc3b9bin06"
    ],
    "switch_option": "off",
    "policy": {
        "threshold": 90,
        "step": 10,
        "size": 600
    }
}

响应示例

状态码： 204

No Content

{ }

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理

相关文档