缩容实例的节点数量
功能介绍
缩容指定实例的节点数量。
接口约束
该接口支持如下数据库实例：
- GeminiDB Cassandra包年/包月实例和按需计费实例
- GeminiDB Redis包年/包月实例和按需计费实例
- GeminiDB Mongo包年/包月实例和按需计费实例
GeminiDB Redis实例支持的最大最小磁盘容量和节点数、规格相关，如果目标结果无法满足实例运行所需的磁盘大小，将无法缩容节点。
GeminiDB Mongo仅支持缩容只读节点。
该接口支持GeminiDB Redis搭建双活关系的主实例和备实例。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/reduce-node
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
租户在某一region下的project ID。获取方法请参见获取项目ID。 |
instance_id |
是 |
String |
实例ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
num |
否 |
Integer |
随机缩减的节点数量。 GeminiDB Cassandra实例该字段取值为1~10。 GeminiDB Redis该字段取值为1。
说明：
如果客户端采用直连节点方式，不推荐使用随机节点缩容。 |
node_list |
否 |
Array of strings |
指定缩容节点的ID，且该节点必须支持节点缩容。如果该字段不传指定缩减的节点ID，将根据系统内部策略缩减指定个数的节点。
说明：
|
响应参数
状态码： 202
参数 |
参数类型 |
描述 |
|---|---|---|
job_id |
String |
任务ID，仅按需实例时会返回该参数。 |
order_id |
String |
订单ID，仅创建包年/包月实例时返回该参数。 |
请求示例
- URI样例
POST https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/reduce-node
- 缩容1个实例节点
{ "num" : 1, "node_list" : [ "116ba14da34a42d28ecd83a38c218907no12" ] }
响应示例
状态码： 202
Accepted
按需实例响应样例：
{
"job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
}
包年/包月实例响应样例：
{
"order_id" : "CS20070721568OVO9"
}
状态码
请参见状态码。
错误码
请参见错误码。
