调用CreateClusterNodePool创建节点池-边缘节点服务 ENS-阿里云

节点池是具有相同属性的一组节点的逻辑集合，允许对节点进行统一的管理和运维，例如节点升级、弹性伸缩等。您可以进一步使用节点池的自动化运维能力，使用OS CVE漏洞自动修复、故障节点自动恢复、kubelet和containerd版本自动升级等功能，降低运维成本。您可以调用CreateClusterNodePool为集群创建节点池。

接口说明

单用户调用频率： 10 次/秒。
创建集群是一个异步的操作，调用接口返回之后，需要等待 10~20 分钟不等，等待集群初始化完成。这个过程中可以调用 DescribeClustersV1 接口查询集群创建状态。集群创建成功之后，可以调用 DescribeClusterUserKubeconfig 获取集群证书。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
ClusterId	string	是	集群 id	eck-xxxxxxxx
NodepoolInfo	object	是	节点池配置。
Name	string	是	节点池名称	test1
ScalingGroup	object	是	伸缩组配置
DesiredSize	integer	否	期望实例数	3
KeyPairName	string	否	实例密钥对（和 password 二选一）	key-pair-name
VswitchIds	array	是	实例使用的 vswitch
	string	否	集群节点所在虚拟交换机 id。vswitch_ids 所处 ENS Region 必须与 ens_region_id 一致。	vsw-58eu2p6v64qw8ihhit1wz7wgv
InstanceChargeType	string	否	实例计费类型	PostPaid
InstanceTypes	array	是	节点池节点实例规格列表。
	string	否	实例规格。	ens.sn1.small
SystemDiskCategory	string	否	系统盘类型，枚举值:local_ssd、local_hdd、cloud_efficiency、cloud_ssd。	cloud_efficiency
SystemDiskSize	integer	否	系统盘规格（单位 GB，最小 20，必须是 10 的倍数）	80
ImageId	string	是	实例镜像 id	m-6734fzvcwcv2o8jj201cpa7ox
DataDisks	array<object>	否	数据盘磁盘大小。单位：GB
	object	否	磁盘类型。
Category	string	否	磁盘类型。	cloud_efficiency
Size	integer	否	数据盘大小（单位 GB，最小 20G，以 10 为步长递增）	80
Password	string	否	节点池创建实例时使用的密码，和密钥对二选一。	some-test-password
KubernetesConfig	object	否	集群相关配置。
PreUserData	string	否	机器创建后，接入集群前执行的脚本，内容需要 base64	ZWNobyBvawo=
UserData	string	否	机器创建后，接入集群后执行的脚本，内容需要 base64	ZWNobyBvawo=

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Nodepool	object	节点池配置。
ClusterId	string	实例 ID。	eck-d2666c5f
NodepoolInfo	object	节点池信息。
Name	string	集群名称。	test1
EnsRegionId	string	集群所在的 ENS Region ID	cn-guiyang-14
NodepoolId	string	节点池 ID。	np1176939548ac49e59febe82dcbf1ad56
ScalingGroup	object	新创建的伸缩组所属的资源组 ID。说明将新创建的伸缩组归属到指定的资源组中。如果不指定该参数，则归属为默认资源组。
VswitchIds	array	集群节点所在虚拟交换机 id。
	string	集群节点所在虚拟交换机 id。	vsw-58eu2p6v64qw8ihhit1wz7wgv
DataDisks	array<object>	节点数据盘信息。
	object	节点数据盘信息。
Category	string	磁盘种类。	cloud_efficiency
Size	integer	数据盘大小规格，单位：GB。	80
InstanceChargeType	string	实例付费方式。	PrePaid
InstanceTypes	array	节点池节点实例规格列表。
	string	节点池节点实例规格。	ens.sn1.small
SystemDiskCategory	string	节点系统盘类型。	cloud_efficiency
SystemDiskSize	integer	系统盘大小规格，单位：GB。	80
ImageId	string	控制面虚拟机镜像 ID	m-67bdk1kpu1ylmt7k33h5dbiov
KeyPairName	string	密钥对名称。	key-pair-name
Password	string	实例登录密码。	**********
KubernetesConfig	object	kubernetes 相关配置。
PreUserData	string	实例创建后，接入集群前执行的脚本，内容需要 base64。	ZWNobyBvawo=
UserData	string	实例创建后，接入集群后执行的脚本，内容需要 base64。	ZWNobyBvawo=
Status	object	节点池状态信息
State	string	节点池状态 active：已达终态 scaling：扩容中 removing_nodes：缩容中	active
TotalNodes	integer	总实例数（包含创建中、使用中、删除中的）。	10
DesiredNodes	integer	期望实例数。	10
ServingNodes	integer	使用中的实例数。	10
InitialNodes	integer	创建中的实例数。	0
RemovingNodes	integer	删除中的实例数。	0
RequestId	string	请求 ID。	C0003E8B-B930-4F59-ADC0-0E209A9012A8

示例

正常返回示例

JSON格式

{
  "Nodepool": {
    "ClusterId": "eck-d2666c5f",
    "NodepoolInfo": {
      "Name": "test1",
      "EnsRegionId": "cn-guiyang-14",
      "NodepoolId": "np1176939548ac49e59febe82dcbf1ad56"
    },
    "ScalingGroup": {
      "VswitchIds": [
        "vsw-58eu2p6v64qw8ihhit1wz7wgv"
      ],
      "DataDisks": [
        {
          "Category": "cloud_efficiency",
          "Size": 80
        }
      ],
      "InstanceChargeType": "PrePaid",
      "InstanceTypes": [
        "ens.sn1.small"
      ],
      "SystemDiskCategory": "cloud_efficiency",
      "SystemDiskSize": 80,
      "ImageId": "m-67bdk1kpu1ylmt7k33h5dbiov",
      "KeyPairName": "key-pair-name",
      "Password": "**********"
    },
    "KubernetesConfig": {
      "PreUserData": "ZWNobyBvawo=",
      "UserData": "ZWNobyBvawo="
    },
    "Status": {
      "State": "active",
      "TotalNodes": 10,
      "DesiredNodes": 10,
      "ServingNodes": 10,
      "InitialNodes": 0,
      "RemovingNodes": 0
    }
  },
  "RequestId": "C0003E8B-B930-4F59-ADC0-0E209A9012A8"
}

错误码

HTTP status code	错误码	错误信息	描述
400	BadRequest	Request param error.	请求参数错误

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。