文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 实例管理/ 变更实例存储容量
更新时间：2024-09-03 GMT+08:00
查看PDF
分享

变更实例存储容量

功能介绍

变更实例的存储容量大小。

接口约束

该接口支持如下数据库实例。

  • GeminiDB Cassandra
  • GeminiDB Redis

该接口既支持包周期实例，也支持按需实例。

调试

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

URI

PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/volume

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

实例ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。
表3 请求Body参数

参数

是否必选

参数类型

描述

size

是

Integer

待变更到的磁盘容量。单位GB，取值为整数。 扩容场景下，必须大于当前磁盘容量。 缩容场景下，必须大于已用量的125%，向上取整。 磁盘容量的上下限与所选接口类型以及规格相关。

is_auto_pay

否

Boolean

扩容包年包月实例存储容量时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。

  • true，表示自动从账户中支付。
  • false，表示手动从账户中支付，默认为该方式。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

job_id

String

任务ID，仅按需实例时会返回该参数。

order_id

String

订单ID，仅创建包年/包月实例时返回该参数。

请求示例

  • URI样例 
    PUT https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/volume
  • 修改实例存储容量为“550GB” 
    {
  "size" : 550
}

响应示例

状态码： 200

Success

按需实例响应样例：

{
  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
}

包周期实例响应样例：

{
  "order_id" : "CS20070721568OVO9"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理

相关文档