调用CreateCluster接口创建边缘容器集群-边缘节点服务 ENS-阿里云

创建边缘容器集群。

接口说明

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ens:CreateCluster

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Name	string	否	集群名称。	mycluster-1
ClusterType	string	是	Kubernetes or ManagedKubernetes，前者为 eck 集群，后者为 serverles vc 必须与 profile 参数一起使用。	Kubernetes
Profile	string	是	Default or Serverless，前者为 eck 集群，后者为 serverless vc 必须与 cluster_type 参数一起使用。	Default
EnsRegionId	string	否	集群所在的 ENS Region ID 。	cn-beijing
KubernetesVersion	string	否	集群版本，与 Kubernetes 社区基线版本保持一致。建议选择最新版本，若不指定，默认使用最新版本。	1.32.1
VpcId	string	否	集群使用的专有网络。	vpc-xxxx
VswitchIds	array	否	集群节点所在虚拟交换机 id。vswitch_ids 所处 ENS Region 必须与 ens_region_id 一致。	["vsw-xxx", "vsw-yyy"]
	string	否	虚拟交换机 ID 列表。	vsw-xxxxxxxxx
PodVswitchIds	array	否	每个 Pod 虚拟交换机分别对应一个 Worker 节点的虚拟交换机，Pod 虚拟交换机和 Worker 节点的虚拟交换机的可用区需保持一致。如果不填，默认使用 vswitch_ids。
	string	否	Pod 虚拟交换机 ID 列表。	vsw-xxxxxxxx
ContainerCidr	string	否	Pod 网络地址段，必须是有效的私有网段，即以下网段及其子网：10.0.0.0/8、172.16-31.0.0/12-16、192.168.0.0/16。不能与 VPC 及 VPC 内已有 Kubernetes 集群使用的网段重复，创建成功后不能修改。	172.20.0.0/16
ServiceCidr	string	否	Service 网络地址段，可选范围：10.0.0.0/16-24，172.16-31.0.0/16-24，192.168.0.0/16-24 不能与 VPC 网段 10.1.0.0/21 及 VPC 内已有 Kubernetes 集群使用的网段重复，创建成功后不能修改。	172.19.0.0/20
PublicAccess	boolean	否	是否开启公网访问。通过 EIP 暴露 API Server，实现集群公网访问。 ● true：开启公网访问。 ● false：不开启公网访问。选择不开放时，则无法通过外网访问集群 API Server。默认值：false。	true
LoadBalancerId	string	否	指定用于 APIServer 访问的 CLB 实例 ID。指定该参数时，将不再自动创建 APIServer CLB。	lb-wz9t256gqa3vbouk****
ControlPlaneConfig	object	否	控制平面配置。
InstanceSpec	string	否	节点实例类型。	ens.esk.sn1.medium
ImageId	string	否	控制面虚拟机镜像 ID。	m-5ul335umat4e2y9ynwi84p3f9
SystemDiskCategory	string	否	节点系统盘类型，可选类型："local_ssd", "cloud_ssd", "cloud_efficiency", "local_hdd"。	cloud_efficiency
SystemDiskSize	integer	否	节点系统盘大小。	120
Runtime	string	否	控制面节点运行时名称。	containerd
NodePortRange	string	否	节点服务端口范围。	30000-32767
Size	integer	否	控制面节点数量，可选值 3 或 5。	3
LoginPassword	string	否	集群控制面机器登录密码。	ThisIsAPassword
ClusterVersion	string	否	集群版本。	1.22.15

返回参数

名称	类型	描述	示例值
	object	响应结构体。
RequestId	string	请求 ID。	C0003E8B-B930-4F59-ADC0-0E209A9012A8
ClusterId	string	实例 ID。	c34b69b095f8241c5a91cc2252dceb976

示例

正常返回示例

JSON格式

{
  "RequestId": "C0003E8B-B930-4F59-ADC0-0E209A9012A8",
  "ClusterId": "c34b69b095f8241c5a91cc2252dceb976"
}

错误码

HTTP status code	错误码	错误信息
400	BadRequest	请求参数错误
400	ClusterNameExist	集群名称已存在
400	UnsupportedClusterVersion	不支持的集群版本
400	ClusterNameFormatError	集群名称格式错误
400	ClusterCountExceed	集群数量超限
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.
500	InternalServerError	内部服务错误

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

变更历史

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