扩容实例存储容量
接口说明
扩容实例相关的存储容量大小。
约束说明
- 该接口既支持包年包月实例，也支持按需实例。
- 不支持集群只读节点扩容存储容量。
URI
|
名称 |
类型 |
IN |
是否必选 |
描述 |
|---|---|---|---|---|
|
X-Auth-Token |
string |
header |
是 |
参数解释： 从IAM服务获取的用户Token。请参考认证鉴权。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
project_id |
string |
path |
是 |
参数解释： 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
instance_id |
string |
path |
是 |
参数解释： 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
请求消息
- 参数说明
表2 参数说明 名称
参数类型
是否必选
描述
volume
Object
是
参数解释：
volume请求详细信息。
详情请参见表3。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
is_auto_pay
Boolean
否
参数解释：
扩容包年包月实例的存储容量时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。
约束限制：
不涉及。
取值范围：
- true，表示自动从账户中支付。
- false，表示手动从账户中支付，默认为该方式。
默认取值：
false。
表3 volume字段数据结构说明 名称
参数类型
是否必选
描述
group_id
String
否
参数解释：
角色组ID。
约束限制：
- 对于副本集实例，不传该参数。
取值范围：
对于集群实例，该参数为shard组ID。
默认取值：
不涉及。
size
String
是
参数解释：
待扩容到的磁盘容量。取值为10的整数倍，并且大于当前磁盘容量。
约束限制：
不涉及。
取值范围：
- 对于集群实例，表示扩容到的单个shard组的磁盘容量。取值范围：shard规格小于8U时：10GB~5000GB。shard规格为8U及以上时，10GB~10000GB。
- 对于副本集实例，表示扩容到的实例的磁盘容量，取值范围：规格小于8U时：10GB~5000GB。规格为8U及以上时，10GB~10000GB。
- 对于单节点实例，表示扩容到的实例的磁盘容量，取值范围：10GB~1000GB。
默认取值：
不涉及。
node_ids
Array of strings
否
参数解释：
副本集只读节点磁盘扩容时，需要传入该参数，当前list只支持传入一个元素。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
请求示例
- 扩容集群实例的存储容量，磁盘容量为20GB
POST https://dds.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein02/enlarge-volume { "volume" : { "group_id" : "1b0c008adbcb495c81a3d5762a02a2abgr02", "size" : 20 } } - 扩容副本集实例的存储容量，磁盘容量为20GB
POST https://dds.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein02/enlarge-volume { "volume" : { "size" : 20 } } - 扩容单节点实例的存储容量，磁盘容量为20GB
POST https://dds.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein02/enlarge-volume { "volume" : { "size" : 20 } }
- 扩容副本集只读节点的存储容量，磁盘容量为20GB
POST https://dds.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein02/enlarge-volume { "volume" : { "size" : 20, "node_ids" : [ "8f643d252d834a4c916b2db4322f9955in02" ] } }
响应消息
- 参数说明
表4 参数说明 名称
参数类型
是否必选
描述
job_id
String
是
参数解释：
任务ID。
取值范围：
不涉及。
order_id
String
否
参数解释：
订单ID，仅扩容包年包月实例的存储容量时返回该参数。
取值范围：
不涉及。
- 响应示例
{ "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890" }
SDK
单击文档数据库服务 DDS SDK，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
状态码
详情请参见状态码。
错误码
详情请参见错误码。
