扩容实例存储容量 - ScalingUpStorageSpaceofanInstance
功能介绍
扩容实例的存储容量大小。
接口约束
该接口支持如下数据库实例：
- GeminiDB Cassandra
- GeminiDB Mongo
- GeminiDB Influx
- GeminiDB Redis Proxy集群版
- GeminiDB Redis 主备版
该接口既支持包周期实例，也支持按需实例。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
gaussdbfornosql:instance:updateVolume
Write
instance *
- g:ResourceTag/<tag-key>
- g:EnterpriseProjectId
nosql:instance:modifyStorageSize
-
URI
POST /v3/{project_id}/instances/{instance_id}/extend-volume
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释： 租户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
instance_id |
是 |
String |
参数解释： 实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
size |
是 |
Integer |
参数解释： 待扩容到的磁盘容量。 约束限制： 取值为整数，并且大于当前磁盘容量。 取值范围： 磁盘容量最大值的大小与所选接口类型以及规格相关。
默认取值： 不涉及。 |
|
is_auto_pay |
否 |
String |
参数解释： 创建包周期实例时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。 约束限制： 不涉及。 取值范围：
默认取值： false。 |
响应参数
状态码： 202
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
job_id |
String |
参数解释： 任务ID，仅按需实例时会返回该参数。 取值范围: 不涉及。 |
|
order_id |
String |
参数解释： 订单ID，仅创建包年/包月实例时返回该参数。 取值范围: 不涉及。 |
请求示例
- URI样例
POST https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/extend-volume
- 扩容实例存储容量至550GB
{ "size" : 550 }
响应示例
状态码： 202
Accepted
按需实例响应样例：
{
"job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
}
包周期实例响应样例：
{
"order_id" : "CS20070721568OVO9"
}
状态码
请参见状态码。
错误码
请参见错误码。
