扩容实例的节点数量
功能介绍
扩容指定实例的节点数量。
接口约束
该接口支持如下数据库实例:
- GeminiDB Cassandra
- GeminiDB Mongo
- GeminiDB Influx
- GeminiDB Redis
GeminiDB Redis实例支持的最大最小磁盘容量和节点数、规格相关,如果目标结果无法满足实例运行所需的磁盘大小,将无法扩容节点。
该接口既支持包周期实例,也支持按需实例。
GeminiDB Influx单节点实例不支持节点扩容。
GeminiDB Mongo仅支持扩容只读节点。
该接口支持GeminiDB Redis搭建双活关系的主实例和备实例。
URI
POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/enlarge-node
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户在某一region下的project ID。获取方法请参见获取项目ID。 |
instance_id |
是 |
String |
实例ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
num |
是 |
Integer |
新增加的节点数量。 |
subnet_id |
否 |
String |
扩容的节点所使用的子网的ID。
|
is_auto_pay |
否 |
String |
创建包周期实例时可指定,表示是否自动从账户中支付,此字段不影响自动续订的支付方式。
|
响应参数
状态码: 202
参数 |
参数类型 |
描述 |
---|---|---|
job_id |
String |
任务ID,仅按需实例时会返回该参数。 |
order_id |
String |
订单ID,仅创建包年/包月实例时返回该参数。 |
请求示例
- URI样例
POST https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/enlarge-node
- 扩容 1个实例节点
{ "num" : 1 }
响应示例
状态码: 202
Accepted
按需实例响应样例:
{ "job_id" : "3711e2ad-5787-49bc-a47f-3f0b066af9f5" }
包周期实例响应样例:
{ "order_id" : "CS20070721568OVO9" }
状态码
请参见状态码。
错误码
请参见错误码。