调用CreateClusterNodePool为集群创建节点池。

调试

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

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

post /clusters/{ClusterId}/nodepools http|https

请求参数

名称 类型 是否必选 示例值 描述
ClusterId String c61da77e8bfbc4c4c999af2b51b65****

集群ID。

body Object

请求体。

auto_scaling Object

自动伸缩配置。

enable Boolean true

是否开启自动伸缩。

max_instances Long 10

最大实例数。

min_instances Long 1

最小实例数。

type String cpu

扩容策略。

kubernetes_config Object

集群相关配置。

cms_enabled Boolean true

是否开启云监控。

cpu_policy String none

CPU管理策略,取值:static或none。

labels Array

ECS标签。

key String disk_type

标签key。

value String ssd

标签值。

runtime String docker

容器运行时。

runtime_version String 19.03.5

容器运行时版本。

taints Array

污点配置。

effect String NoSchedule

污点策略。

key String k-1

污点key。

value String v-1

污点值。

user_data String dGhpcyBpcyBhIGV4YW1wbGU=

节点自定义数据。

nodepool_info Object

节点池配置。

name String cluster-demo

节点池名称。

resource_group_id String rg-acfmyvw3wjmb****

节点池所在资源ID。

scaling_group Object

节点池扩容组配置。

auto_renew Boolean true

节点池节点是否开启自动续费,当instance_charge_type取值为PrePaid时才生效,可选值为:

  • true:自动续费。
  • false:不自动续费。
auto_renew_period Long 1

节点池节点自动续费周期,当选择预付费和自动续费时才生效,且为必选值: PeriodUnit=Month时,取值{“1”, “2”, “3”, “6”, “12”}。

data_disks Array

节点池节点数据盘配置。

category String cloud_ssd

数据盘类型,取值:

  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD云盘。
encrypted String false

数据盘是否加密。

size Long 40

数据盘大小,单位GB。

image_id String aliyun_2_1903_x64_20G_alibase_20200529.vhd

自定义镜像ID,如果不传则使用系统镜像。

instance_charge_type String PrePaid

节点池节点付费类型,可选值为:

  • PrePaid:预付费
  • PostPaid:按量付费

默认为按量付费。

instance_types Array of String ecs.d1ne.2xlarge

实例规格。

key_pair String ***

免密登录密钥对名称,和login_password二选一。

login_password String ***

SSH登录密码,和key_pair二选一。

period Long 1

节点池节点包年包月时长,当instance_charge_type取值为PrePaid时才生效且为必选值,取值范围: PeriodUnit=Month时,Period取值:{ “1”, “2”, “3”,“6”,“12”}。

period_unit String Month

节点池节点付费周期,当指定为PrePaid的时候需要指定周期。Month:以月为计时单位。

platform String Linux

操作系统发行版。取值:

  • CentOS
  • AliyunLinux
  • Windows
  • WindowsCore
rds_instances Array of String rds-***

1

scaling_policy String release

扩容策略,即机型分类,例如cpu:x86 计算。

security_group_id String sg-wz9a8g2mt6x5llu0****

安全组ID。

system_disk_category String cloud_efficiency

节点系统盘类型,取值:

  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD云盘。
system_disk_size Long 120

节点系统盘大小。

tags Array

节点标签。

key String node-k-1

标签key。

value String node-v-1

标签值。

vpc_id String vpc-wz984yvbd6lck22z3****

VPC网络ID。

vswitch_ids Array of String vsw-wz9mfnhmssud6eicu****

1

tee_config Object

加密计算配置。

tee_enable Boolean true

是否为加密计算节点池。

返回数据

名称 类型 示例值 描述
nodepool_id String "np31da1b38983f4511b490fc62108a****"

节点池ID。

示例

请求示例

POST /clusters/{ClusterId}/nodepools HTTP/1.1
公共请求头
{
    "ClusterId":"c61da77e8bfbc4c4c999af2b51b65****",
    "nodepool_info":{
        "name":"cluster-demo",
        "resource_group_id":"rg-aek2aa7u22q****"
    },
    "scaling_group":{
        "vswitch_ids":[
            "vsw-wz9mfnhmssud6eicu****"
        ],
        "system_disk_category":"cloud_efficiency",
        "system_disk_size":120,
        "data_disks":[
            {
                "category":"cloud_ssd",
                "size":40,
                "encrypted":"false"
            }
        ],
        "instance_types":[
            "ecs.d1ne.2xlarge"
        ],
        "vpc_id":"vpc-wz984yvbd6lck22z3****",
        "tags":[
            {
                "key":"k-1",
                "value":"v-1"
            }
        ],
        "instance_charge_type":"PrePaid",
        "login_password":"****",
        "period":1,
        "period_unit":"Month",
        "auto_renew":true,
        "auto_renew_period":1,
        "security_group_id":"sg-wz9a8g2mt6x5llu0****",
        "platform":"AliyunLinux",
        "image_id":"aliyun_2_1903_x64_20G_alibase_20200529.vhd",
        "rds_instances":[

        ]
    },
    "kubernetes_config":{
        "cpu_policy":"none",
        "cms_enabled":true,
        "labels":[
            {
                "key":"k-2",
                "value":"v-2"
            }
        ],
        "taints":[
            {
                "key":"k-3",
                "value":"v-3",
                "effect":"NoSchedule"
            }
        ],
        "user_data":"MTEx",
        "runtime":"docker",
        "runtime_version":"19.03.5"
    },
    "tee_config":{
        "tee_enable":true
    }
}

请求示例补充说明

自动伸缩示例:
{
    "ClusterId":"c61da77e8bfbc4c4c999af2b51b65****",
    "nodepool_info":{
        "name":"autoScale-demo",
        "resource_group_id":"rg-acfmyvw3wjm****"
    },
    "scaling_group":{
        "vswitch_ids":[
            "vsw-wz9mfnhmssud6eic****"
        ],
        "system_disk_category":"cloud_efficiency",
        "system_disk_size":120,
        "data_disks":[

        ],
        "instance_types":[
            "ecs.t6-c1m2.large"
        ],
        "vpc_id":"vpc-wz984yvbd6lck22z3****",
        "tags":[

        ],
        "instance_charge_type":"PostPaid",
        "login_password":"****",
        "platform":"AliyunLinux",
        "image_id":"aliyun_2_1903_x64_20G_alibase_20200529.vhd",
        "rds_instances":[

        ],
        "scaling_policy":"release"
    },
    "kubernetes_config":{
        "cpu_policy":"none",
        "cms_enabled":false,
        "labels":[
            {
                "key":"workload_type",
                "value":"cpu"
            }
        ],
        "taints":[

        ],
        "user_data":"",
        "runtime":"docker",
        "runtime_version":"19.03.5"
    },
    "tee_config":{
        "tee_enable":true
    },
    "auto_scaling":{
        "enable":true,
        "max_instances":10,
        "min_instances":1,
        "type":"cpu"
    }
}

正常返回示例

XML 格式

<nodepool_id>np31da1b38983f4511b490fc62108a****</nodepool_id>

JSON 格式

{
    "nodepool_id": "np31da1b38983f4511b490fc62108a****"
}

错误码

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