Help Center/ Cloud Container Engine_Autopilot/ API Reference/ APIs/ Autopilot Cluster Management/ Creating a Cluster
Updated on 2024-11-12 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Creating a Cluster

Function

This API is used to create an empty cluster, which has only master nodes but no worker nodes.

  • The URL for cluster management is in the format of https://Endpoint/uri, where uri specifies the resource path for API access.

Constraints

Before calling the CCE API to create a cluster, ensure that the following conditions are met:

  • A VPC is available. Otherwise, the cluster cannot be created. If a VPC is available, you do not need to create a new one. A VPC provides an isolated, configurable, manageable virtual network environment for CCE clusters. If no VPC is available, you need to create one first. For details, see Creating a VPC.

  • Before creating a cluster, you should properly plan the Service CIDR block. After a cluster using a container tunnel network is created, you cannot modify the CIDR blocks. After a cluster using a VPC network or Cloud Native 2.0 network is created, you can only add CIDR blocks or subnet CIDR blocks to the cluster but cannot modify the existing CIDR blocks or subnet CIDR blocks. To modify the existing CIDR blocks, you need to create a new cluster. Exercise caution when performing this operation.

  • An agency has been correctly created and is not deleted. If the agency verification fails, the cluster fails to be created. You can log in to the CCE console to see if there is any agency. If no agency is created, the system prompts you to create one. If an agency has been created, no message is displayed.

  • By default, an account can create up to five clusters in each region. If you need to create more clusters, you can submit an application to increase the quota. For details, see How Do I Increase My Quota?

Calling Method

For details, see Calling APIs.

URI

POST /autopilot/v3/projects/{project_id}/clusters

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Details:

Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

Constraints:

None

Options:

Project IDs of the account

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Details:

Request body type or format

Constraints:

The GET method is not verified.

Options:

  • application/json

  • application/json;charset=utf-8

  • application/x-pem-file

Default value:

N/A

X-Auth-Token

Yes

String

Details:

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token.

Constraints:

None

Options:

N/A

Default value:

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

kind

Yes

String

API type. The value is fixed at Cluster or cluster and cannot be changed.

apiVersion

Yes

String

API version. The value is fixed at v3 and cannot be changed.

metadata

Yes

AutopilotClusterMetadata object

Basic information about a cluster. Metadata is a collection of attributes.

spec

Yes

AutopilotClusterSpec object

Element type of the collection class. The main part of a cluster object to be managed is in spec. CCE creates or updates objects by defining or updating spec.

status

No

AutopilotClusterStatus object

Element type of the collection class, which is used to record the statuses of an object in the system, including the cluster status and the ID of the cluster creation job
Table 4 AutopilotClusterMetadata

Parameter

Mandatory

Type

Description

name

Yes

String

Cluster name.

Enter 4 to 128 characters starting with a lowercase letter and not ending with a hyphen (-). Only lowercase letters, digits, and hyphens (-) are allowed.

uid

No

String

Cluster ID, which uniquely identifies a resource. The value is automatically generated after the object is created. A custom value will not take effect. When you create a yearly/monthly cluster, no cluster ID will be returned in the response body.

alias

No

String

Alias of a cluster name displayed on the CCE console, and the name can be changed.

Enter 4 to 128 characters starting with a lowercase letter and not ending with a hyphen (-). Only lowercase letters, digits, and hyphens (-) are allowed.

A cluster alias must be unique.

In the request body for creating or updating a cluster, if the cluster alias is not specified or is left blank, the alias of the cluster is the same as the cluster name. In the response body for creating a cluster, if the cluster alias is not configured, the cluster alias will not be returned.

annotations

No

Map<String,String>

Cluster annotations in the format of key-value pairs.

"annotations": {
   "key1" : "value1",
   "key2" : "value2"
}
NOTE:

  • Annotations are not used to label or select objects. The metadata in annotations may be small or large, structured or unstructured, and may include characters that are not allowed in labels.

  • This field is not stored in the database and is used only to specify the add-ons to be installed in the cluster.

labels

No

Map<String,String>

Cluster labels in the format of key-value pairs.

NOTE:

The value of this field is automatically generated by the system and is used by the frontend to identify the features supported by a cluster during the upgrade. Customized values are invalid.

creationTimestamp

No

String

Time when a cluster was created

updateTimestamp

No

String

Time when a cluster was updated
Table 5 AutopilotClusterSpec

Parameter

Mandatory

Type

Description

category

No

String

Cluster type. Only Turbo is supported.

type

No

String

Master node architecture.

  • VirtualMachine: The master node is an x86 server.

flavor

Yes

String

Cluster specifications: cce.autopilot.cluster

version

No

String

Version of a cluster, which mirrors the baseline version of the Kubernetes community. The latest version is recommended.

You can create clusters of the latest three versions on the CCE console. To learn which cluster versions are available, log in to the CCE console, create a cluster, and check supported cluster versions.

You can call APIs to create clusters of other versions. However, these cluster versions will be gradually terminated. For details about the support policy, see the CCE announcement.

NOTE:

  • If not specified, a cluster of the latest version will be created.

platformVersion

No

String

CCE cluster platform version, which is an internal version under the cluster version (version). Platform versions are used to trace iterations in a major cluster version. They are unique within a major cluster version and recounted when the major cluster version changes. This parameter cannot be customized, and when you create a cluster, the latest corresponding platform version is selected automatically.

The format of platformVersion is cce.X.Y.

  • X: internal feature version, which indicates changes in features, patches, or OS support in the cluster version. The value starts from 1 and increases monotonically.

  • Y: patch version of an internal feature version. It is used only for software package update after the feature version is released. No other modification is involved. The value starts from 0 and increases monotonically.

description

No

String

Cluster description, for example, which purpose the cluster is intended to serve. By default, this field is left blank. To modify cluster description after a cluster is created, call the API for updating a specified cluster or go to the cluster details page on the CCE console. Only UTF-8 encoding is supported.

customSan

No

Array of strings

The custom SAN field in the API server certificate of a cluster. It complies with the format specifications defined by the SSL standard X509. It is not supported by Autopilot clusters.

  1. Duplicate names are not allowed.

  2. The format must comply with the IP address and domain name formats.

Example:

SAN 1: DNS Name=example.com
SAN 2: DNS Name=www.example.com
SAN 3: DNS Name=example.net
SAN 4: IP Address=93.184.216.34

enableSnat

No

Boolean

Whether SNAT is configured for a cluster. This parameter is used and returned only by the Autopilot cluster creation API. After this function is enabled, the cluster can access the Internet through a NAT gateway. By default, the existing NAT gateway in the selected VPC is used. Otherwise, the system automatically creates a NAT gateway of the default specifications, binds an EIP to the NAT gateway, and configures SNAT rules.

enableSWRImageAccess

No

Boolean

Whether a cluster is interconnected with SWR. This parameter is used and returned only by the Autopilot cluster creation API. To ensure that your cluster nodes can pull images from SWR, the existing SWR and OBS endpoints in the selected VPC are used by default. If not, new SWR and OBS endpoints will be automatically created.

enableAutopilot

No

Boolean

Whether the cluster is an Autopilot cluster

ipv6enable

No

Boolean

Whether a cluster uses the IPv6 mode. This parameter is not supported by Autopilot clusters.

hostNetwork

Yes

AutopilotHostNetwork object

Node networking parameters, including VPC and subnet ID. This field is mandatory because nodes in a cluster communicate with each other using a VPC.

containerNetwork

Yes

AutopilotContainerNetwork object

Container networking parameters, including the container network model and container CIDR block

eniNetwork

No

AutopilotEniNetwork object

Cloud Native 2.0 network settings

serviceNetwork

No

AutopilotServiceNetwork object

Service CIDR block, including IPv4 CIDR block

authentication

No

AutopilotAuthentication object

Configuration of the cluster authentication mode, which is not supported by Autopilot clusters

billingMode

No

Integer

Cluster billing mode

  • 0: pay-per-use

This parameter defaults to pay-per-use.

kubernetesSvcIpRange

No

String

Service CIDR block or the IP address range which the kubernetes clusterIP must fall within. If this parameter is not specified during cluster creation, the default value 10.247.0.0/16 is used. This parameter is being deprecated, so you can use serviceNetwork instead. The new field contains the IPv4 CIDR blocks.

clusterTags

No

Array of AutopilotResourceTag objects

Cluster resource tags

kubeProxyMode

No

String

Service forwarding mode.

  • iptables: Traditional kube-proxy uses iptables rules to implement Service load balancing. In this mode, too many iptables rules will be generated when many Services are deployed. In addition, non-incremental updates will cause latency and even tangible performance issues in the case of service traffic spikes.

NOTE:

iptables is used by default.

az

No

String

AZ. This field is returned only for a query.

For details about AZs supported by CCE, see Regions and Endpoints.

extendParam

No

AutopilotClusterExtendParam object

Extended field to decide whether a cluster will span across AZs or belong to a specified enterprise project, or whether a dedicated CCE cluster is to be created

configurationsOverride

No

Array of AutopilotPackageConfiguration objects

Overrides the default component configurations in a cluster. It is not supported in CCE Autopilot clusters.
Table 6 AutopilotHostNetwork

Parameter

Mandatory

Type

Description

vpc

Yes

String

ID of the VPC used to create a master node.

Obtain the value using either of the following methods:

  • Method 1: Log in to the VPC console and view the VPC ID on the VPC details page.

  • Method 2: Use the VPC API.

    For details, see Querying VPCs.

subnet

Yes

String

Network ID of the subnet used to create a master node. Obtain the value using either of the following methods:

  • Method 1: Log in to the VPC console and click the target subnet on the Subnets page. You can view the network ID on the displayed page.

  • Method 2: Use the VPC API to obtain subnets.

    For details, see Querying Subnets.
Table 7 AutopilotContainerNetwork

Parameter

Mandatory

Type

Description

mode

Yes

String

Container network type

  • eni*: specifies the Cloud Native 2.0 network model. This model has integrated cloud native elastic network interfaces (ENIs), uses VPC CIDR blocks to allocate container IP addresses, and supports ELB passthrough networking for high network performance. Use this model when creating a cluster.
Table 8 AutopilotEniNetwork

Parameter

Mandatory

Type

Description

subnets

Yes

Array of AutopilotNetworkSubnet objects

IPv4 subnet ID list of the subnet where an ENI resides. Obtain the value using either of the following methods:

  • Method 1: Log in to the VPC console and click the target subnet on the Subnets page. You can view the IPv4 subnet ID on the displayed page.

  • Method 2: Use the VPC API to obtain subnets.

    For details, see Querying Subnets.
Table 9 AutopilotNetworkSubnet

Parameter

Mandatory

Type

Description

subnetID

Yes

String

Specifies the IPv4 subnet ID of the subnet used to create control nodes and containers. (IPv6 is not supported.) To obtain the subnet ID, use either of the following methods:

  • Method 1: Log in to the VPC console and click a subnet in the VPC. On the subnet details page, search for the IPv4 subnet ID.

  • Method 2: Use the VPC API for obtaining subnets.

For details, see Querying Subnets.
Table 10 AutopilotServiceNetwork

Parameter

Mandatory

Type

Description

IPv4CIDR

No

String

Value range of the Kubernetes clusterIP IPv4 CIDR block. If this parameter is not specified during cluster creation, the default value 10.247.0.0/16 is used.
Table 11 AutopilotAuthentication

Parameter

Mandatory

Type

Description

mode

No

String

Cluster authentication mode. The default value is rbac.
Table 12 AutopilotResourceTag

Parameter

Mandatory

Type

Description

key

No

String

Key.

  • Cannot be null. Max characters: 128.

  • Use letters, digits, and spaces in UTF-8 format.

  • Can contain the following special characters: _.:/=+-@.

  • Cannot start with _sys_.

value

No

String

Value.

  • Can be null but not the default. Max characters: 255.

  • Use letters, digits, and spaces in UTF-8 format.

  • Can contain the following special characters: _.:/=+-@.
Table 13 AutopilotClusterExtendParam

Parameter

Mandatory

Type

Description

enterpriseProjectId

No

String

ID of the enterprise project that a cluster belongs to

NOTE:

  • An enterprise project can be configured only after the enterprise project function is enabled.

upgradefrom

No

String

Records of how a cluster is upgraded to its current version
Table 14 AutopilotPackageConfiguration

Parameter

Mandatory

Type

Description

name

No

String

Component name

configurations

No

Array of AutopilotConfigurationItem objects

Component configuration items
Table 15 AutopilotConfigurationItem

Parameter

Mandatory

Type

Description

name

No

String

Component configuration item name

value

No

Object

Component configuration item value
Table 16 AutopilotClusterStatus

Parameter

Mandatory

Type

Description

phase

No

String

Cluster status. Options:

  • Available: The cluster is running properly.

  • Unavailable: The cluster is exhibiting unexpected behavior and needs to be manually deleted.

  • ScalingUp: Nodes are being added to the cluster.

  • ScalingDown: The cluster is being downsized to fewer nodes.

  • Creating: The cluster is being created.

  • Deleting: The cluster is being deleted.

  • Upgrading: The cluster is being upgraded.

  • Resizing: Cluster specifications are being changed.

  • ResizeFailed: Cluster specification changing is abnormal.

  • RollingBack: The cluster is being rolled back.

  • RollbackFailed: The cluster rollback is abnormal.

  • Hibernating: The cluster is being hibernated.

  • Hibernation: The cluster is in hibernation.

  • Freezing: The cluster is being frozen.

  • Frozen: The cluster has been frozen.

  • UnFreezing: The cluster is being unfrozen.

  • Awaking: The cluster is being woken up from hibernation.

  • Empty: The cluster does not have any resources. This field is discarded.

  • Error: Resources in the cluster are abnormal. You can manually delete the cluster.

jobID

No

String

ID of the task associated with the current cluster status. Options:

  • ID of the associated task returned when creating a cluster. You can use it to obtain the auxiliary tasks for creating a cluster.

  • ID of the associated task returned when a cluster fails to be deleted or is being deleted. If this parameter is not empty, you can use the task ID to obtain the auxiliary tasks for deleting a cluster.

NOTE:

Tasks are short-lived. Do not use task information in scenarios such as cluster status determination.

reason

No

String

Why a cluster changes to the current state. This parameter is returned if the cluster is not in the Available state.

message

No

String

Detailed information about why a cluster changes to the current state. This parameter is returned if the cluster is not in the Available state.

endpoints

No

Array of AutopilotClusterEndpoints objects

Access address of kube-apiserver in a cluster

isLocked

No

Boolean

CBC resource locked

lockScene

No

String

Scenario where the CBC resource is locked

lockSource

No

String

Resource locked

lockSourceId

No

String

ID of a locked resource

deleteOption

No

Object

Status of the configuration to be deleted. This parameter is contained only in the response to the deletion request.

deleteStatus

No

Object

Information of the status to be deleted. This parameter is contained only in the response to the deletion request.
Table 17 AutopilotClusterEndpoints

Parameter

Mandatory

Type

Description

url

No

String

Access address of kube-apiserver in a cluster

type

No

String

Type of the cluster access address

  • Internal: address for internal network access

  • External: address for external network access

Response Parameters

Status code: 201

Table 18 Response body parameters

Parameter

Type

Description

kind

String

API type. The value is fixed at Cluster or cluster and cannot be changed.

apiVersion

String

API version. The value is fixed at v3 and cannot be changed.

metadata

AutopilotClusterMetadata object

Basic information about a cluster. Metadata is a collection of attributes.

spec

AutopilotClusterSpec object

Element type of the collection class. The main part of a cluster object to be managed is in spec. CCE creates or updates objects by defining or updating spec.

status

AutopilotClusterStatus object

Element type of the collection class, which is used to record the statuses of an object in the system, including the cluster status and the ID of the cluster creation job
Table 19 AutopilotClusterMetadata

Parameter

Type

Description

name

String

Cluster name.

Enter 4 to 128 characters starting with a lowercase letter and not ending with a hyphen (-). Only lowercase letters, digits, and hyphens (-) are allowed.

uid

String

Cluster ID, which uniquely identifies a resource. The value is automatically generated after the object is created. A custom value will not take effect. When you create a yearly/monthly cluster, no cluster ID will be returned in the response body.

alias

String

Alias of a cluster name displayed on the CCE console, and the name can be changed.

Enter 4 to 128 characters starting with a lowercase letter and not ending with a hyphen (-). Only lowercase letters, digits, and hyphens (-) are allowed.

A cluster alias must be unique.

In the request body for creating or updating a cluster, if the cluster alias is not specified or is left blank, the alias of the cluster is the same as the cluster name. In the response body for creating a cluster, if the cluster alias is not configured, the cluster alias will not be returned.

annotations

Map<String,String>

Cluster annotations in the format of key-value pairs.

"annotations": {
   "key1" : "value1",
   "key2" : "value2"
}
NOTE:

  • Annotations are not used to label or select objects. The metadata in annotations may be small or large, structured or unstructured, and may include characters that are not allowed in labels.

  • This field is not stored in the database and is used only to specify the add-ons to be installed in the cluster.

labels

Map<String,String>

Cluster labels in the format of key-value pairs.

NOTE:

The value of this field is automatically generated by the system and is used by the frontend to identify the features supported by a cluster during the upgrade. Customized values are invalid.

creationTimestamp

String

Time when a cluster was created

updateTimestamp

String

Time when a cluster was updated
Table 20 AutopilotClusterSpec

Parameter

Type

Description

category

String

Cluster type. Only Turbo is supported.

type

String

Master node architecture.

  • VirtualMachine: The master node is an x86 server.

flavor

String

Cluster specifications: cce.autopilot.cluster

version

String

Version of a cluster, which mirrors the baseline version of the Kubernetes community. The latest version is recommended.

You can create clusters of the latest three versions on the CCE console. To learn which cluster versions are available, log in to the CCE console, create a cluster, and check supported cluster versions.

You can call APIs to create clusters of other versions. However, these cluster versions will be gradually terminated. For details about the support policy, see the CCE announcement.

NOTE:

  • If not specified, a cluster of the latest version will be created.

platformVersion

String

CCE cluster platform version, which is an internal version under the cluster version (version). Platform versions are used to trace iterations in a major cluster version. They are unique within a major cluster version and recounted when the major cluster version changes. This parameter cannot be customized, and when you create a cluster, the latest corresponding platform version is selected automatically.

The format of platformVersion is cce.X.Y.

  • X: internal feature version, which indicates changes in features, patches, or OS support in the cluster version. The value starts from 1 and increases monotonically.

  • Y: patch version of an internal feature version. It is used only for software package update after the feature version is released. No other modification is involved. The value starts from 0 and increases monotonically.

description

String

Cluster description, for example, which purpose the cluster is intended to serve. By default, this field is left blank. To modify cluster description after a cluster is created, call the API for updating a specified cluster or go to the cluster details page on the CCE console. Only UTF-8 encoding is supported.

customSan

Array of strings

The custom SAN field in the API server certificate of a cluster. It complies with the format specifications defined by the SSL standard X509. It is not supported by Autopilot clusters.

  1. Duplicate names are not allowed.

  2. The format must comply with the IP address and domain name formats.

Example:

SAN 1: DNS Name=example.com
SAN 2: DNS Name=www.example.com
SAN 3: DNS Name=example.net
SAN 4: IP Address=93.184.216.34

enableSnat

Boolean

Whether SNAT is configured for a cluster. This parameter is used and returned only by the Autopilot cluster creation API. After this function is enabled, the cluster can access the Internet through a NAT gateway. By default, the existing NAT gateway in the selected VPC is used. Otherwise, the system automatically creates a NAT gateway of the default specifications, binds an EIP to the NAT gateway, and configures SNAT rules.

enableSWRImageAccess

Boolean

Whether a cluster is interconnected with SWR. This parameter is used and returned only by the Autopilot cluster creation API. To ensure that your cluster nodes can pull images from SWR, the existing SWR and OBS endpoints in the selected VPC are used by default. If not, new SWR and OBS endpoints will be automatically created.

enableAutopilot

Boolean

Whether the cluster is an Autopilot cluster

ipv6enable

Boolean

Whether a cluster uses the IPv6 mode. This parameter is not supported by Autopilot clusters.

hostNetwork

AutopilotHostNetwork object

Node networking parameters, including VPC and subnet ID. This field is mandatory because nodes in a cluster communicate with each other using a VPC.

containerNetwork

AutopilotContainerNetwork object

Container networking parameters, including the container network model and container CIDR block

eniNetwork

AutopilotEniNetwork object

Cloud Native 2.0 network settings

serviceNetwork

AutopilotServiceNetwork object

Service CIDR block, including IPv4 CIDR block

authentication

AutopilotAuthentication object

Configuration of the cluster authentication mode, which is not supported by Autopilot clusters

billingMode

Integer

Cluster billing mode

  • 0: pay-per-use

This parameter defaults to pay-per-use.

kubernetesSvcIpRange

String

Service CIDR block or the IP address range which the kubernetes clusterIP must fall within. If this parameter is not specified during cluster creation, the default value 10.247.0.0/16 is used. This parameter is being deprecated, so you can use serviceNetwork instead. The new field contains the IPv4 CIDR blocks.

clusterTags

Array of AutopilotResourceTag objects

Cluster resource tags

kubeProxyMode

String

Service forwarding mode.

  • iptables: Traditional kube-proxy uses iptables rules to implement Service load balancing. In this mode, too many iptables rules will be generated when many Services are deployed. In addition, non-incremental updates will cause latency and even tangible performance issues in the case of service traffic spikes.

NOTE:

iptables is used by default.

az

String

AZ. This field is returned only for a query.

For details about AZs supported by CCE, see Regions and Endpoints.

extendParam

AutopilotClusterExtendParam object

Extended field to decide whether a cluster will span across AZs or belong to a specified enterprise project, or whether a dedicated CCE cluster is to be created

configurationsOverride

Array of AutopilotPackageConfiguration objects

Overrides the default component configurations in a cluster. It is not supported in CCE Autopilot clusters.
Table 21 AutopilotHostNetwork

Parameter

Type

Description

vpc

String

ID of the VPC used to create a master node.

Obtain the value using either of the following methods:

  • Method 1: Log in to the VPC console and view the VPC ID on the VPC details page.

  • Method 2: Use the VPC API.

    For details, see Querying VPCs.

subnet

String

Network ID of the subnet used to create a master node. Obtain the value using either of the following methods:

  • Method 1: Log in to the VPC console and click the target subnet on the Subnets page. You can view the network ID on the displayed page.

  • Method 2: Use the VPC API to obtain subnets.

    For details, see Querying Subnets.
Table 22 AutopilotContainerNetwork

Parameter

Type

Description

mode

String

Container network type

  • eni*: specifies the Cloud Native 2.0 network model. This model has integrated cloud native elastic network interfaces (ENIs), uses VPC CIDR blocks to allocate container IP addresses, and supports ELB passthrough networking for high network performance. Use this model when creating a cluster.
Table 23 AutopilotEniNetwork

Parameter

Type

Description

subnets

Array of AutopilotNetworkSubnet objects

IPv4 subnet ID list of the subnet where an ENI resides. Obtain the value using either of the following methods:

  • Method 1: Log in to the VPC console and click the target subnet on the Subnets page. You can view the IPv4 subnet ID on the displayed page.

  • Method 2: Use the VPC API to obtain subnets.

    For details, see Querying Subnets.
Table 24 AutopilotNetworkSubnet

Parameter

Type

Description

subnetID

String

Specifies the IPv4 subnet ID of the subnet used to create control nodes and containers. (IPv6 is not supported.) To obtain the subnet ID, use either of the following methods:

  • Method 1: Log in to the VPC console and click a subnet in the VPC. On the subnet details page, search for the IPv4 subnet ID.

  • Method 2: Use the VPC API for obtaining subnets.

For details, see Querying Subnets.
Table 25 AutopilotServiceNetwork

Parameter

Type

Description

IPv4CIDR

String

Value range of the Kubernetes clusterIP IPv4 CIDR block. If this parameter is not specified during cluster creation, the default value 10.247.0.0/16 is used.
Table 26 AutopilotAuthentication

Parameter

Type

Description

mode

String

Cluster authentication mode. The default value is rbac.
Table 27 AutopilotResourceTag

Parameter

Type

Description

key

String

Key.

  • Cannot be null. Max characters: 128.

  • Use letters, digits, and spaces in UTF-8 format.

  • Can contain the following special characters: _.:/=+-@.

  • Cannot start with _sys_.

value

String

Value.

  • Can be null but not the default. Max characters: 255.

  • Use letters, digits, and spaces in UTF-8 format.

  • Can contain the following special characters: _.:/=+-@.
Table 28 AutopilotClusterExtendParam

Parameter

Type

Description

enterpriseProjectId

String

ID of the enterprise project that a cluster belongs to

NOTE:

  • An enterprise project can be configured only after the enterprise project function is enabled.

upgradefrom

String

Records of how a cluster is upgraded to its current version
Table 29 AutopilotPackageConfiguration

Parameter

Type

Description

name

String

Component name

configurations

Array of AutopilotConfigurationItem objects

Component configuration items
Table 30 AutopilotConfigurationItem

Parameter

Type

Description

name

String

Component configuration item name

value

Object

Component configuration item value
Table 31 AutopilotClusterStatus

Parameter

Type

Description

phase

String

Cluster status. Options:

  • Available: The cluster is running properly.

  • Unavailable: The cluster is exhibiting unexpected behavior and needs to be manually deleted.

  • ScalingUp: Nodes are being added to the cluster.

  • ScalingDown: The cluster is being downsized to fewer nodes.

  • Creating: The cluster is being created.

  • Deleting: The cluster is being deleted.

  • Upgrading: The cluster is being upgraded.

  • Resizing: Cluster specifications are being changed.

  • ResizeFailed: Cluster specification changing is abnormal.

  • RollingBack: The cluster is being rolled back.

  • RollbackFailed: The cluster rollback is abnormal.

  • Hibernating: The cluster is being hibernated.

  • Hibernation: The cluster is in hibernation.

  • Freezing: The cluster is being frozen.

  • Frozen: The cluster has been frozen.

  • UnFreezing: The cluster is being unfrozen.

  • Awaking: The cluster is being woken up from hibernation.

  • Empty: The cluster does not have any resources. This field is discarded.

  • Error: Resources in the cluster are abnormal. You can manually delete the cluster.

jobID

String

ID of the task associated with the current cluster status. Options:

  • ID of the associated task returned when creating a cluster. You can use it to obtain the auxiliary tasks for creating a cluster.

  • ID of the associated task returned when a cluster fails to be deleted or is being deleted. If this parameter is not empty, you can use the task ID to obtain the auxiliary tasks for deleting a cluster.

NOTE:

Tasks are short-lived. Do not use task information in scenarios such as cluster status determination.

reason

String

Why a cluster changes to the current state. This parameter is returned if the cluster is not in the Available state.

message

String

Detailed information about why a cluster changes to the current state. This parameter is returned if the cluster is not in the Available state.

endpoints

Array of AutopilotClusterEndpoints objects

Access address of kube-apiserver in a cluster

isLocked

Boolean

CBC resource locked

lockScene

String

Scenario where the CBC resource is locked

lockSource

String

Resource locked

lockSourceId

String

ID of a locked resource

deleteOption

Object

Status of the configuration to be deleted. This parameter is contained only in the response to the deletion request.

deleteStatus

Object

Information of the status to be deleted. This parameter is contained only in the response to the deletion request.
Table 32 AutopilotClusterEndpoints

Parameter

Type

Description

url

String

Access address of kube-apiserver in a cluster

type

String

Type of the cluster access address

  • Internal: address for internal network access

  • External: address for external network access

Example Requests

Create an Autopilot cluster of v1.28 billed on a pay-per-use basis.

/autopilot/v3/projects/{project_id}/clusters

{
  "kind" : "Cluster",
  "apiVersion" : "v3",
  "metadata" : {
    "name" : "test-cluster-autopilot",
    "annotations" : {
      "cluster.install.addons/install" : "[{\"addonTemplateName\":\"coredns\",\"values\":{\"flavor\":{\"category\":[\"Autopilot\"],\"is_default\":true,\"name\":\"autopilot-flavor1\",\"replicas\":2,\"resources\":[{\"limitsCpu\":1,\"limitsMem\":\"2Gi\",\"name\":\"coredns\",\"requestsCpu\":1,\"requestsMem\":\"2Gi\"}]}}},{\"addonTemplateName\":\"metrics-server\",\"values\":{\"flavor\":{\"category\":[\"Autopilot\"],\"description\":\"custom resources in autopilot cluster\",\"is_default\":true,\"name\":\"autopilot-flavor1\",\"replicas\":2,\"resources\":[{\"limitsCpu\":1,\"limitsMem\":\"2Gi\",\"name\":\"metrics-server\",\"requestsCpu\":1,\"requestsMem\":\"2Gi\"}]}}}]"
    }
  },
  "spec" : {
    "category" : "Turbo",
    "flavor" : "cce.autopilot.cluster",
    "type" : "VirtualMachine",
    "version" : "v1.28",
    "hostNetwork" : {
      "vpc" : "c6549063-d459-4ae1-9550-b5fec6741b0f",
      "subnet" : "xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    },
    "extendParam" : {
      "enterpriseProjectId" : "0"
    },
    "containerNetwork" : {
      "mode" : "eni"
    },
    "description" : "",
    "billingMode" : 0,
    "eniNetwork" : {
      "subnets" : [ {
        "subnetID" : "186f9322-50c5-4e5a-91e3-47da86959afc"
      } ]
    },
    "enableSWRImageAccess" : true,
    "enableSnat" : true,
    "serviceNetwork" : {
      "IPv4CIDR" : "10.247.0.0/16"
    }
  }
}

Example Responses

Status code: 201

The cluster creation job is delivered.

{
  "kind" : "Cluster",
  "apiVersion" : "v3",
  "metadata" : {
    "name" : "test-cluster-autopilot",
    "uid" : "e18f8b25-2270-11ef-a160-0255ac100100",
    "creationTimestamp" : "2024-06-04 12:49:28.773718231 +0000 UTC",
    "updateTimestamp" : "2024-06-04 12:49:28.773718305 +0000 UTC",
    "annotations" : {
      "jobid" : "e1c49157-2270-11ef-a160-0255ac100100",
      "resourceJobId" : "e18fa26f-2270-11ef-a160-0255ac100100"
    }
  },
  "spec" : {
    "category" : "Turbo",
    "type" : "VirtualMachine",
    "flavor" : "cce.autopilot.cluster",
    "version" : "v1.28",
    "platformVersion" : "cce.4.0",
    "hostNetwork" : {
      "vpc" : "c6549063-d459-4ae1-9550-b5fec6741b0f",
      "subnet" : "3b18c2d5-b352-4f59-b421-c2d2d48a1333"
    },
    "containerNetwork" : {
      "mode" : "eni"
    },
    "eniNetwork" : {
      "subnets" : [ {
        "subnetID" : "186f9322-50c5-4e5a-91e3-47da86959afc"
      } ]
    },
    "serviceNetwork" : {
      "IPv4CIDR" : "10.247.0.0/16"
    },
    "authentication" : {
      "mode" : "rbac"
    },
    "billingMode" : 0,
    "kubernetesSvcIpRange" : "10.247.0.0/16",
    "kubeProxyMode" : "iptables",
    "extendParam" : {
      "enterpriseProjectId" : "0"
    },
    "enableSWRImageAccess" : true,
    "enableSnat" : true
  },
  "status" : {
    "phase" : "Creating",
    "jobID" : "e1c49157-2270-11ef-a160-0255ac100100"
  }
}

SDK Sample Code

The SDK sample code is as follows.

Create an Autopilot cluster of v1.28 billed on a pay-per-use basis.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.cce.v3.region.CceRegion;
import com.huaweicloud.sdk.cce.v3.*;
import com.huaweicloud.sdk.cce.v3.model.*;

import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.util.HashMap;

public class CreateAutopilotClusterSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        CceClient client = CceClient.newBuilder()
                .withCredential(auth)
                .withRegion(CceRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateAutopilotClusterRequest request = new CreateAutopilotClusterRequest();
        AutopilotCluster body = new AutopilotCluster();
        AutopilotClusterExtendParam extendParamSpec = new AutopilotClusterExtendParam();
        extendParamSpec.withEnterpriseProjectId("0");
        AutopilotServiceNetwork serviceNetworkSpec = new AutopilotServiceNetwork();
        serviceNetworkSpec.withIpv4CIDR("10.247.0.0/16");
        List<AutopilotNetworkSubnet> listEniNetworkSubnets = new ArrayList<>();
        listEniNetworkSubnets.add(
            new AutopilotNetworkSubnet()
                .withSubnetID("186f9322-50c5-4e5a-91e3-47da86959afc")
        );
        AutopilotEniNetwork eniNetworkSpec = new AutopilotEniNetwork();
        eniNetworkSpec.withSubnets(listEniNetworkSubnets);
        AutopilotContainerNetwork containerNetworkSpec = new AutopilotContainerNetwork();
        containerNetworkSpec.withMode(AutopilotContainerNetwork.ModeEnum.fromValue("eni"));
        AutopilotHostNetwork hostNetworkSpec = new AutopilotHostNetwork();
        hostNetworkSpec.withVpc("c6549063-d459-4ae1-9550-b5fec6741b0f")
            .withSubnet("xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx");
        AutopilotClusterSpec specbody = new AutopilotClusterSpec();
        specbody.withCategory(AutopilotClusterSpec.CategoryEnum.fromValue("Turbo"))
            .withType(AutopilotClusterSpec.TypeEnum.fromValue("VirtualMachine"))
            .withFlavor("cce.autopilot.cluster")
            .withVersion("v1.28")
            .withDescription("")
            .withEnableSnat(true)
            .withEnableSWRImageAccess(true)
            .withHostNetwork(hostNetworkSpec)
            .withContainerNetwork(containerNetworkSpec)
            .withEniNetwork(eniNetworkSpec)
            .withServiceNetwork(serviceNetworkSpec)
            .withBillingMode(0)
            .withExtendParam(extendParamSpec);
        Map<String, String> listMetadataAnnotations = new HashMap<>();
        listMetadataAnnotations.put("cluster.install.addons/install", "[{"addonTemplateName":"coredns","values":{"flavor":{"category":["Autopilot"],"is_default":true,"name":"autopilot-flavor1","replicas":2,"resources":[{"limitsCpu":1,"limitsMem":"2Gi","name":"coredns","requestsCpu":1,"requestsMem":"2Gi"}]}}},{"addonTemplateName":"metrics-server","values":{"flavor":{"category":["Autopilot"],"description":"custom resources in autopilot cluster","is_default":true,"name":"autopilot-flavor1","replicas":2,"resources":[{"limitsCpu":1,"limitsMem":"2Gi","name":"metrics-server","requestsCpu":1,"requestsMem":"2Gi"}]}}}]");
        AutopilotClusterMetadata metadatabody = new AutopilotClusterMetadata();
        metadatabody.withName("test-cluster-autopilot")
            .withAnnotations(listMetadataAnnotations);
        body.withSpec(specbody);
        body.withMetadata(metadatabody);
        body.withApiVersion("v3");
        body.withKind("Cluster");
        request.withBody(body);
        try {
            CreateAutopilotClusterResponse response = client.createAutopilotCluster(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Create an Autopilot cluster of v1.28 billed on a pay-per-use basis.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcce.v3.region.cce_region import CceRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcce.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = CceClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CceRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateAutopilotClusterRequest()
        extendParamSpec = AutopilotClusterExtendParam(
            enterprise_project_id="0"
        )
        serviceNetworkSpec = AutopilotServiceNetwork(
            i_pv4_cidr="10.247.0.0/16"
        )
        listSubnetsEniNetwork = [
            AutopilotNetworkSubnet(
                subnet_id="186f9322-50c5-4e5a-91e3-47da86959afc"
            )
        ]
        eniNetworkSpec = AutopilotEniNetwork(
            subnets=listSubnetsEniNetwork
        )
        containerNetworkSpec = AutopilotContainerNetwork(
            mode="eni"
        )
        hostNetworkSpec = AutopilotHostNetwork(
            vpc="c6549063-d459-4ae1-9550-b5fec6741b0f",
            subnet="xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        )
        specbody = AutopilotClusterSpec(
            category="Turbo",
            type="VirtualMachine",
            flavor="cce.autopilot.cluster",
            version="v1.28",
            description="",
            enable_snat=True,
            enable_swr_image_access=True,
            host_network=hostNetworkSpec,
            container_network=containerNetworkSpec,
            eni_network=eniNetworkSpec,
            service_network=serviceNetworkSpec,
            billing_mode=0,
            extend_param=extendParamSpec
        )
        listAnnotationsMetadata = {
            "cluster.install.addons/install": "[{"addonTemplateName":"coredns","values":{"flavor":{"category":["Autopilot"],"is_default":true,"name":"autopilot-flavor1","replicas":2,"resources":[{"limitsCpu":1,"limitsMem":"2Gi","name":"coredns","requestsCpu":1,"requestsMem":"2Gi"}]}}},{"addonTemplateName":"metrics-server","values":{"flavor":{"category":["Autopilot"],"description":"custom resources in autopilot cluster","is_default":true,"name":"autopilot-flavor1","replicas":2,"resources":[{"limitsCpu":1,"limitsMem":"2Gi","name":"metrics-server","requestsCpu":1,"requestsMem":"2Gi"}]}}}]"
        }
        metadatabody = AutopilotClusterMetadata(
            name="test-cluster-autopilot",
            annotations=listAnnotationsMetadata
        )
        request.body = AutopilotCluster(
            spec=specbody,
            metadata=metadatabody,
            api_version="v3",
            kind="Cluster"
        )
        response = client.create_autopilot_cluster(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Create an Autopilot cluster of v1.28 billed on a pay-per-use basis.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cce "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := cce.NewCceClient(
        cce.CceClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateAutopilotClusterRequest{}
	enterpriseProjectIdExtendParam:= "0"
	extendParamSpec := &model.AutopilotClusterExtendParam{
		EnterpriseProjectId: &enterpriseProjectIdExtendParam,
	}
	iPv4CIDRServiceNetwork:= "10.247.0.0/16"
	serviceNetworkSpec := &model.AutopilotServiceNetwork{
		IPv4CIDR: &iPv4CIDRServiceNetwork,
	}
	var listSubnetsEniNetwork = []model.AutopilotNetworkSubnet{
        {
            SubnetID: "186f9322-50c5-4e5a-91e3-47da86959afc",
        },
    }
	eniNetworkSpec := &model.AutopilotEniNetwork{
		Subnets: listSubnetsEniNetwork,
	}
	containerNetworkSpec := &model.AutopilotContainerNetwork{
		Mode: model.GetAutopilotContainerNetworkModeEnum().ENI,
	}
	hostNetworkSpec := &model.AutopilotHostNetwork{
		Vpc: "c6549063-d459-4ae1-9550-b5fec6741b0f",
		Subnet: "xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
	}
	categorySpec:= model.GetAutopilotClusterSpecCategoryEnum().TURBO
	typeSpec:= model.GetAutopilotClusterSpecTypeEnum().VIRTUAL_MACHINE
	versionSpec:= "v1.28"
	descriptionSpec:= ""
	enableSnatSpec:= true
	enableSWRImageAccessSpec:= true
	billingModeSpec:= int32(0)
	specbody := &model.AutopilotClusterSpec{
		Category: &categorySpec,
		Type: &typeSpec,
		Flavor: "cce.autopilot.cluster",
		Version: &versionSpec,
		Description: &descriptionSpec,
		EnableSnat: &enableSnatSpec,
		EnableSWRImageAccess: &enableSWRImageAccessSpec,
		HostNetwork: hostNetworkSpec,
		ContainerNetwork: containerNetworkSpec,
		EniNetwork: eniNetworkSpec,
		ServiceNetwork: serviceNetworkSpec,
		BillingMode: &billingModeSpec,
		ExtendParam: extendParamSpec,
	}
	var listAnnotationsMetadata = map[string]string{
        "cluster.install.addons/install": "[{"addonTemplateName":"coredns","values":{"flavor":{"category":["Autopilot"],"is_default":true,"name":"autopilot-flavor1","replicas":2,"resources":[{"limitsCpu":1,"limitsMem":"2Gi","name":"coredns","requestsCpu":1,"requestsMem":"2Gi"}]}}},{"addonTemplateName":"metrics-server","values":{"flavor":{"category":["Autopilot"],"description":"custom resources in autopilot cluster","is_default":true,"name":"autopilot-flavor1","replicas":2,"resources":[{"limitsCpu":1,"limitsMem":"2Gi","name":"metrics-server","requestsCpu":1,"requestsMem":"2Gi"}]}}}]",
    }
	metadatabody := &model.AutopilotClusterMetadata{
		Name: "test-cluster-autopilot",
		Annotations: listAnnotationsMetadata,
	}
	request.Body = &model.AutopilotCluster{
		Spec: specbody,
		Metadata: metadatabody,
		ApiVersion: "v3",
		Kind: "Cluster",
	}
	response, err := client.CreateAutopilotCluster(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

201

The cluster creation job is delivered.

Error Codes

See Error Codes.

Parent Topic: Autopilot Cluster Management