文档首页/ 云搜索服务 CSS/ API参考/ API/ 集群管理接口/ 指定节点类型缩容
更新时间：2025-01-22 GMT+08:00
查看PDF
分享

指定节点类型缩容

功能介绍

该接口用于集群对不同类型实例的个数以及存储容量进行缩容。包周期类型的集群不支持通过api进行指定节点类型缩容操作。

在缩容前，建议备份所有关键数据，以免造成数据丢失。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。

URI

POST /v1.0/extend/{project_id}/clusters/{cluster_id}/role/shrink

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。获取方法请参见获取项目ID和名称。

约束限制:

不涉及

取值范围:

获取方法请参见获取项目ID和名称。

默认取值:

不涉及

cluster_id

是

String

参数解释:

指定待缩容的集群ID，获取方法请参见获取集群ID。

约束限制:

不涉及

取值范围:

获取方法请参见获取集群ID。

默认取值:

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

shrink

是

Array of ShrinkNodeReq objects

参数解释:

需要缩容的节点类型和数量集合。

agency_name

否

String

参数解释:

委托名称，委托给CSS服务，允许CSS调用您的其他云服务。

约束限制:

对接了IAM新平面时该参数必填，对接IAM旧平面时该参数可选。

取值范围:

委托需要有VPC的操作权限："vpc:subnets:get","vpc:ports:*"。

默认取值:

不涉及
表3 ShrinkNodeReq

参数

是否必选

参数类型

描述

reducedNodeNum

是

Integer

参数解释:

需要缩容的节点数量。

  • 对节点缩容后，请确保每个节点类型在每个AZ中的数量至少为1。

  • 关于跨AZ的集群，在不同AZ中同类型节点个数的差值要小于等于1。

  • 关于没有Master节点的集群，每次缩容的数据节点个数(包含冷数据节点和其他类型节点)要小于当前数据节点总数的一半，缩容后的数据节点个数要大于索引的最大副本个数。

  • 关于有Master节点的集群，每次缩容的Master节点个数要小于当前Master节点总数的一半，缩容后的Master节点个数必须是奇数且不小于3。

type

是

String

参数解释:

指定节点类型。

取值范围:

  • ess：数据节点。

  • ess-cold：冷数据节点。

  • ess-client：Client节点。

  • ess-master：Master节点。

响应参数

无

请求示例

缩容集群，通过指定当前节点类型缩容。

POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/role/shrink

{
  "shrink" : [ {
    "type" : "ess",
    "reducedNodeNum" : 1
  } ]
}

响应示例

无

状态码

状态码

描述

200

请求已成功。

400

非法请求。

建议直接修改该请求，不要重试该请求。

409

服务器在完成请求时发生冲突。

返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。

412

未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。

错误码

请参见错误码。

父主题： 集群管理接口