
# 扩容实例的节点数量 - AddingNodesforanInstance
#### 功能介绍
扩容指定实例的节点数量。
#### 接口约束
该接口支持如下数据库实例：
- GeminiDB Cassandra
- GeminiDB Mongo
- GeminiDB Influx
- GeminiDB Redis
GeminiDB Redis实例支持的最大最小磁盘容量和节点数、规格相关，如果目标结果无法满足实例运行所需的磁盘大小，将无法扩容节点。
该接口既支持包周期实例，也支持按需实例。
GeminiDB Influx单节点实例不支持节点扩容。
GeminiDB Mongo仅支持扩容只读节点。
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforNoSQL&api=ExpandInstanceNode)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-nosql/nosql_05_0023.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                              | 访问级别  | 资源类型（\*为必须） | 条件键                                                                                                                                                                                                                    | 别名                        | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | gaussdbfornosql:instance:addNode | Write | instance \* | - g:ResourceTag/\<tag-key\>  - g:EnterpriseProjectId   | nosql:instance:extendNode | -      |
     
  
 
#### URI
POST /v3/{project_id}/instances/{instance_id}/enlarge-node
表1路径参数 
| 参数          | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|:---|:---|:---|:---|
| project_id  | 是    | String | **参数解释：** 租户在某一region下的project ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nosql/nosql_projectid.html)。 **约束限制：** 不涉及。 **取值范围：** 长度为32个字符，仅由英文字母和数字组成。 **默认取值：** 不涉及。     |
| instance_id | 是    | String | **参数解释：** 实例ID。可以调用[查询实例列表和详情 - QueryingInstancesandDetails](https://support.huaweicloud.com/api-nosql/nosql_05_0016.html)接口获取。如果未申请实例，可以调用[创建实例 - CreatinganInstance](https://support.huaweicloud.com/api-nosql/nosql_05_0014.html)接口创建。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
表3请求Body参数 
| 参数          | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|:---|:---|:---|:---|
| num         | 是    | Integer | **参数解释：** 新增加的节点数量。 **约束限制** **：** 取值为正整数。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| subnet_id   | 否    | String  | **参数解释：** 扩容的节点所使用的子网的ID。 获取方法如下： - 方法1：登录[虚拟私有云服务控制台](https://console.huaweicloud.com/vpc/#/vpc/vpcs/list)，在虚拟私有云的详情页面查找VPC ID。  - 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考[查询VPC列表](https://support.huaweicloud.com/api-vpc/vpc_api01_0003.html)。   **约束限制：** - 该参数只支持GeminiDB Cassandra数据库实例扩容节点时传入。  - 所传入的子网ID必须属于实例当前所在的VPC。   **取值范围：** 不涉及。 **默认取值：** 不传该参数时，系统会为当前扩容的节点选择一个IP容量较为充足的子网。 |
| is_auto_pay | 否    | String  | **参数解释：** 表示是否自动从账户中支付，此字段不影响自动续订的支付方式。 **约束限制：** 该参数仅对包周期实例有效，按需实例无需传入此参数。 **取值范围：** - true，表示自动从账户中支付。  - false，表示手动从账户中支付，默认为该方式。   **默认取值：** false                                                                                                                                                                                                                                                                                                                                                                                                                          |
   
#### 响应参数
**状态码： 202**
表4响应Body参数 
| 参数       | 参数类型   | 描述                                                                                                                                                 |
|:---|:---|:---|
| job_id   | String | **参数解释：** 任务ID，仅按需实例时会返回该参数。 **取值范围** **：** 不涉及。  |
| order_id | String | **参数解释：** 订单ID，仅包年/包月实例时返回该参数。 **取值范围** **：** 不涉及。 |
   
#### 请求示例
扩容 1个实例节点
```
POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/enlarge-node
{
  "num" : 1
}
```
#### 响应示例
**状态码： 202**
Accepted
按需实例响应样例：
```
{
  "job_id" : "3711e2ad-5787-49bc-a47f-3f0b066af9f5"
}
```
包周期实例响应样例：
```
{
  "order_id" : "CS20070721568OVO9"
}
```
#### 状态码
请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-nosql/nosql_error_code.html)。
