变更实例存储容量
功能介绍
变更实例的存储容量大小。
接口约束
该接口支持如下数据库实例。
- GeminiDB Cassandra
- GeminiDB Redis Proxy集群版
- GeminiDB Redis 主备版
该接口既支持包周期实例,也支持按需实例。
URI
PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/volume
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 租户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
instance_id |
是 |
String |
参数解释: 实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
size |
是 |
Integer |
参数解释: 待变更到的磁盘容量。单位GB,取值为整数。 约束限制: 扩容场景下,必须大于当前磁盘容量。 缩容场景下,必须大于已用量的125%,向上取整。 取值范围: 磁盘容量的上下限与所选接口类型以及规格相关。 默认取值: 不涉及。 |
is_auto_pay |
否 |
Boolean |
参数解释: 扩容包年包月实例存储容量时可指定,表示是否自动从账户中支付,此字段不影响自动续订的支付方式。 约束限制: 不涉及。 取值范围:
默认取值: false |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
job_id |
String |
参数解释: 任务ID,仅按需实例时会返回该参数。 取值范围: 不涉及。 |
order_id |
String |
参数解释: 订单ID,仅变更包年包月实例存储容量时返回该参数。 取值范围: 不涉及。 |
请求示例
- URI样例
PUT https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/volume
- 修改实例存储容量为“550GB”
{ "size" : 550 }
响应示例
状态码: 200
Success
按需实例响应样例:
{ "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890" }
包周期实例响应样例:
{ "order_id" : "CS20070721568OVO9" }
状态码
请参见状态码。
错误码
请参见错误码。