
# 缩容实例的节点数量 - DeletingNodesfromaSpecifiedInstance
#### 功能介绍
缩容指定实例的节点数量。
#### 接口约束
该接口支持如下数据库实例：
- GeminiDB Cassandra
- GeminiDB Redis
- GeminiDB Mongo
GeminiDB Redis实例支持的最大最小磁盘容量和节点数、规格相关，如果目标结果无法满足实例运行所需的磁盘大小，将无法缩容节点。
该接口既支持包周期实例，也支持按需实例。
GeminiDB Mongo仅支持缩容只读节点。
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforNoSQL&api=ShrinkInstanceNode)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-nosql/nosql_05_0023.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                                 | 访问级别  | 资源类型（\*为必须） | 条件键                                                                                                                                                                                                                             | 别名                                                                                                                                                                                                                         | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | gaussdbfornosql:instance:deleteNode | Write | instance \* | - g:ResourceTag/\<tag-key\>  - g:EnterpriseProjectId   | - nosql:instance:delete  - nosql:instance:reduceNode   | -      |
     
  
 
#### URI
POST /v3/{project_id}/instances/{instance_id}/reduce-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          | **参数解释：** 随机缩减的节点数量。 说明： 如果客户端采用直连节点方式，不推荐使用随机节点缩容。 **约束限制：** 数值类型。num与node_list必须有一个字段传值，如果num与node_list同时传值时，则以node_list的值为主。 **取值范围：** - GeminiDB Cassandra实例该字段取值为1\~10。  - GeminiDB Redis该字段取值为1\~10。   **默认取值：** 不涉及。                                                                                                                                                                                                                                                                                                                                         |
| node_list | 否    | Array of strings | **参数解释：** 指定缩容节点的ID，且该节点必须支持节点缩容。如果该字段不传指定缩减的节点ID，将根据系统内部策略缩减指定个数的节点。可以调用[查询实例列表和详情 - QueryingInstancesandDetails](https://support.huaweicloud.com/api-nosql/nosql_05_0016.html)接口获取节点ID。 **约束限制：** - num与node_list必须有一个字段传值。 - 如果node_list传值时，GeminiDB Cassandra长度必须为1\~10，GeminiDB Redis长度必须为1\~10。  - 如果num与node_list同时传值时，则以node_list的值为主。    - 如果node_list取值为空时，缩容以随机节点缩容进行；node_list字段取值不为空，缩容以指定节点ID进行。  - 节点缩容前，请避免直连节点，以防该节点缩容导致业务中断。   |
   
#### 响应参数
**状态码： 202**
表4响应Body参数 
| 参数       | 参数类型   | 描述                                                                                                                                             |
|:---|:---|:---|
| job_id   | String | **参数解释：** 任务ID，仅按需实例时会返回该参数。 **取值范围：** 不涉及。   |
| order_id | String | **参数解释：** 订单ID，仅创建包年/包月实例时返回该参数。 **取值范围：** 不涉及。 |
   
#### 请求示例
缩容1个实例节点
```
POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/reduce-node
{
   "num" : 1,
   "node_list" : [ "116ba14da34a42d28ecd83a38c218907no12" ]
}
```
#### 响应示例
**状态码： 202**
Accepted
按需实例响应样例：
```
{
  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
}
```
包年/包月实例响应样例：
```
{
  "order_id" : "CS20070721568OVO9"
}
```
#### 状态码
请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-nosql/nosql_error_code.html)。
