创建控制节点池--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

创建控制节点池

最近更新时间：2024.12.04 14:07:17首次发布时间：2023.08.24 19:59:30

本接口用于创建控制节点池。

使用说明

调用该接口前，请调用获取边缘集群支持的资源类型接口，确认创建节点池时需要用到的资源是否在指定的地域和可用区中支持。
此接口为异步接口，当此接口返回成功时，会返回节点池的 ID 信息，此时节点池将进入{Creating, [Progressing]}状态，直到创建执行成功。请调用获取节点池列表及详情接口获取该节点池当前的状态，查看节点池是否创建成功。有关状态说明，请参见资源状态说明。

请求说明

请求方式：POST
请求地址：https://veecp.volcengineapi.com/?Action=CreateNodePool&Version=2021-03-03

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。其他公共参数，请参见公共参数。

参数	类型	是否必选	示例值	描述
Action	String	是	CreateNodePool	公共参数，本接口取值为`CreateNodePool`。
Version	String	是	2021-03-03	公共参数，本接口取值为`2021-03-03`。
ClientToken	String	否	BusinessRequest12345	用于保证请求幂等性的字符串。该字符串由调用方传入，需保证不同请求之间唯一。ClientToken 对大小写敏感，且最大值不超过 64 个 ASCII 字符。
ClusterId	String	是	cc5silumrsfeq****	节点池所在集群的 ID。在集群页面，鼠标指针悬浮到集群名称上，获取集群 ID。您也可以调用获取集群列表及详情接口，获取集群 ID。说明集群必须处于`{Running,[*]}` 或 `{Updating,[Progressing]}` 状态。
Name	String	是	test-nodepool	节点池名称。同一个集群下，节点池名称必须唯一；支持大小写英文字母、汉字、数字、短划线（-）；数字不能在首位，短划线（-）不能在首位或末位；长度限制为 2～64 个字符。说明不能使用默认节点池保留名：`vke-default-nodepool。`
KubernetesConfig	EdgeNodePoolKubernetesConfig	否	详见请求示例	节点池 Kubernetes 配置。
NodeConfig	NodeConfigRequest	是	详见请求示例	节点池中云服务器（ECS）实例配置。
Tags	[]Tag	否	详见请求示例	节点池绑定标签信息。 Tags 中各个 Key不可重复；资源已有相同 TagKey 的情况下，重复绑定标签不会报错，会更新为最新的 TagValue； Tags 中的 key、value 不允许在最前或最后输入空格，后端会直接去除空格；单个资源最多支持绑定 50 个标签。

请求示例

POST /?Action=CreateNodePool&Version=2021-03-03 HTTP/1.1
Content-Type:application/json
{
    "ClusterId": "cc5silumrsfeq****",
    "Name": "test-nodepool",
    "KubernetesConfig": {
        "Labels": [
            {
                "Key": "label-key",
                "Value": "label-value"
            }
        ],
        "Taints": [
            {
                "Key": "taint-key",
                "Value": "taint-value",
                "Effect": "NoSchedule"
            }
        ],
        "Cordon": false
    },
    "NodeConfig": {
        "InstanceTypeIds": ["ecs.g1.xlarge"],
        "SubnetIds": ["subnet-3rf6vwbgkg****"],
        "SystemVolume": {
            "Size": 40,
            "Type": "ESSD_PL0"
        },
        "DataVolumes": [
            {
                "Size": 20,
                "Type": "ESSD_PL0"
            }
        ],
        "AdditionalContainerStorageEnabled": true,
        "InitializeScript": "ZWNobyAidG******",
        "Security": {
            "SecurityGroupIds": ["sg-2byy13cnsczy****"],
            "SecurityStrategies": ["Hids"],
            "Login": {
                "Password": "UHdkMTIz***"
            }
        },
        "NamePrefix": "name-prefix"，
        "Tags":[
            {
                "Key":"key",
                "Value":"value"
            }
        ]
    },
    "Tags":[
        {
            "Key":"key",
            "Value":"value"
        }
    ]，
    "ClientToken": "BC028527-33B9-4990-A633-84E9F9******",
}

返回参数

参数	类型	示例值	描述
Id	String	pc51i0m6rsfen****	节点池 ID。

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "021635330810134****",
        "Action": "CreateNodePool",
        "Version": "2021-03-03",
        "Service": "veecp_openapi",
        "Region": "cn-beijing"
    },
    "Result": {
        "Id": "pc51i0m6rsfen****"
    }
}

错误码

本接口无特有错误码，错误码请参见公共错误码。