更新时间:2026-04-07 GMT+08:00

伸缩节点池

功能介绍

该API用于伸缩指定的节点池

集群管理的URL格式为:https://Endpoint/uri。其中uri为资源路径,也即API访问的路径

调用方法

请参见如何调用API。

URI

POST /api/v3/projects/{project_id}/clusters/{cluster_id}/nodepools/{nodepool_id}/operation/scale

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,获取方式请参见如何获取接口URI中参数。

约束限制:

不涉及

取值范围:

账号的项目ID

默认取值:

不涉及

cluster_id

是

String

参数解释:

集群ID,获取方式请参见如何获取接口URI中参数。

约束限制:

不涉及

取值范围:

集群ID

默认取值:

不涉及

nodepool_id

是

String

参数解释:

节点池ID,获取方式请参见如何获取接口URI中参数。

约束限制:

不涉及

取值范围:

节点池ID

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

参数解释:

消息体的类型(格式)

约束限制:

GET方法不做校验

取值范围:

  • application/json

  • application/json;charset=utf-8

  • application/x-pem-file

  • multipart/form-data(注:存在FormData参数时使用)

默认取值:

不涉及

X-Auth-Token

是

String

参数解释:

调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值,获取方式请参见获取token。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

kind

是

String

参数解释:

API类型

约束限制:

不涉及

取值范围:

固定值“NodePool”

默认取值:

不涉及

apiVersion

是

String

参数解释:

API版本

约束限制:

不涉及

取值范围:

固定值“v3”

默认取值:

不涉及

spec

是

ScaleNodePoolSpec object

参数解释:

伸缩节点池请求详细参数

约束限制:

不涉及

表4 ScaleNodePoolSpec

参数

是否必选

参数类型

描述

desiredNodeCount

是

Integer

参数解释:

节点池的预期总数量。执行扩容操作时,需将当前节点数与扩容数量相加;执行缩容操作时,需从当前节点数中减去缩容数量。

约束限制:

必填参数,如果省略则默认值为0,会导致删除节点池伸缩组下的所有节点

取值范围:

0或正整数

默认取值:

0

scaleGroups

是

Array of strings

参数解释:

要扩缩容的节点池中的伸缩组名称,通过获取指定的节点池接口获取伸缩组名称。扩容时可选择多个伸缩组,系统将按照尽量均分或随机策略在所选伸缩组间分配扩容节点数,缩容时则仅能指定单个伸缩组进行操作。

约束限制:

如果要伸缩默认伸缩组填"default"

取值范围:

不涉及

默认取值:

不涉及

options

否

ScaleNodePoolOptions object

参数解释:

节点池伸缩选项配置

约束限制:

不涉及

表5 ScaleNodePoolOptions

参数

是否必选

参数类型

描述

scalableChecking

否

String

参数解释:

扩容状态检查策略

约束限制:

不涉及

取值范围:

  • instant:同步检查,下发扩容请求时同步校验底层资源是否售罄

  • async:异步检查,下发扩容请求时异步校验底层资源是否售罄

默认取值:

instant

scalePolicy

否

String

参数解释:

扩容的策略,允许为空,该参数scaleGroups传多项时有效。

约束限制:

不涉及

取值范围:

  • AZBalance:AZ优先策略,扩容节点池时,系统会使各个AZ间的节点数尽可能的均衡,规格会在所选伸缩组中随机指定。该策略适用于对节点成本和可用区无特殊要求的场景,优点是配置简便、降低单点故障风险。注意:如果某个AZ资源不足,该AZ期望的扩容节点会向其他AZ扩容,可能会使AZ间节点不均衡。如需解决该问题,可在该AZ资源充足时尝试再次扩容。

  • Random:随机策略,从下发的规格scaleGroups列表中随机选择伸缩组扩容。

默认取值:

Random

响应参数

状态码:202

表6 响应Body参数

参数

参数类型

描述

String

请求示例

  • 扩容节点池默认伸缩组(按需)

    {
      "kind" : "NodePool",
      "apiVersion" : "v3",
      "spec" : {
        "desiredNodeCount" : 1,
        "scaleGroups" : [ "default" ]
      }
    }
  • 扩容节点池默认伸缩组(包年包月)

    {
      "kind" : "NodePool",
      "apiVersion" : "v3",
      "spec" : {
        "desiredNodeCount" : 1,
        "scaleGroups" : [ "default" ],
        "options" : {
          "billingConfigOverride" : {
            "billingMode" : 1,
            "extendParam" : {
              "periodNum" : 1,
              "periodType" : "month",
              "isAutoRenew" : false,
              "isAutoPay" : false
            }
          }
        }
      }
    }

响应示例

状态码:202

表示节点池伸缩已经被接受,节点池将根据伸缩后的节点池期望节点数增加或者删除节点池中的节点

{
  "orderID" : "CS2504231542LJVS6"
}

状态码

状态码

描述

202

表示节点池伸缩已经被接受,节点池将根据伸缩后的节点池期望节点数增加或者删除节点池中的节点

错误码

请参见错误码。