Reading a Specified Cluster
Function
This API is used to obtain details about a specified cluster.
The URL for cluster management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the path for API access.
URI
GET /api/v3/projects/{project_id}/clusters/{cluster_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. |
cluster_id |
Yes |
String |
Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
detail |
No |
String |
Whether the details about a cluster are queried. If this parameter is set to true, the total number of nodes (totalNodesNumber), number of normal nodes (activeNodesNumber), total CPUs (totalNodesCPU), total memory size (totalNodesMemory), and installed add-ons (installedAddonInstances) will be added to the annotation. The details of installed add-ons include the add-on name (addonTemplateName), version (version), and status (status). |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Content-Type |
Yes |
String |
Message body type (format). |
X-Auth-Token |
Yes |
String |
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. |
Response Parameters
Status code: 200
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 |
ClusterMetadata object |
Basic information about a cluster. Metadata is a collection of attributes. |
spec |
ClusterSpec object |
Detailed description of the cluster. CCE creates or updates objects by defining or updating spec. |
status |
ClusterStatus object |
Cluster status. |
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 user-defined value will not take effect. |
annotations |
Map<String,String> |
Cluster annotations, in the format of key-value pairs. "annotations": { "key1" : "value1", "key2" : "value2" }
NOTE:
|
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 the cluster during the upgrade. Customized values are invalid. |
creationTimestamp |
String |
Time when the cluster was created. |
updateTimestamp |
String |
Time when the cluster was updated. |
Parameter |
Type |
Description |
---|---|---|
category |
String |
Cluster type:
|
type |
String |
Master node architecture:
|
flavor |
String |
Default value: When you create a CCE cluster, the value is cce.s1.small for non-DeC scenarios and cce.dec.s1.small for DeC scenarios. Cluster flavor, which cannot be changed after the cluster is created.
NOTE:
|
version |
String |
Cluster version, which mirrors the baseline version of the Kubernetes community. The latest version is recommended. You can create clusters of two latest versions on the CCE console. To learn which cluster versions are available, log in to the CCE console, create a cluster, and check the Version parameter. You can call APIs to create clusters of other versions. However, these clusters will be gradually brought offline. For details about the support policy, see the CCE announcement.
NOTE:
|
platformVersion |
String |
CCE cluster platform version, indicating the 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. When you create a cluster, the latest corresponding platform version is automatically selected. The format of platformVersion is cce.X.Y.
|
description |
String |
Cluster description, for example, which purpose the cluster is intended to serve. By default, this field is left unspecified. To modify cluster description after the cluster is created, call the API for updating cluster information or go to the cluster details page on the CCE console. Only UTF-8 encoding is supported. |
customSan |
Array of strings |
Custom SAN field in the server certificate of the cluster API server, which must comply with the SSL and X509 format specifications.
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 |
ipv6enable |
Boolean |
Whether the cluster supports IPv6 addresses. This field is supported in clusters of v1.15 and later versions. |
hostNetwork |
HostNetwork object |
Node networking parameters, including VPC and subnet ID. This field is mandatory because nodes in a cluster communicate with each other by using a VPC. |
containerNetwork |
ContainerNetwork object |
Container networking parameters, including the container network model and container CIDR block. |
authentication |
Authentication object |
Configurations of the cluster authentication mode. |
billingMode |
Integer |
Billing mode of a cluster.
Defaults to pay-per-use. |
masters |
Array of MasterSpec objects |
Advanced configurations of master nodes |
kubernetesSvcIpRange |
String |
Service CIDR block or the IP address range which kubernetes clusterIp must fall within. This field is available only for clusters of v1.11.7 and later. |
clusterTags |
Array of ResourceTag objects |
Cluster resource tags. |
kubeProxyMode |
String |
Service forwarding mode. Two modes are available:
|
az |
String |
AZ. This field is returned only for a query. |
extendParam |
ClusterExtendParam object |
Extended field to decide whether the cluster will span across AZs or belong to a specified enterprise project, or whether a dedicated CCE cluster is to be created. |
supportIstio |
Boolean |
Whether Istio is supported. |
configurationsOverride |
Array of PackageConfiguration objects |
Whether to overwrite the default component configurations of the cluster. If a component or a parameter that is not supported by the component is specified, this configuration is ignored. For details about the supported configurable components and their parameters, see |
Parameter |
Type |
Description |
---|---|---|
vpc |
String |
ID of the VPC used to create a master node You can obtain it in either of the following ways:
NOTE:
Currently, the VPC network model does not support interconnection with VPCs that contain a secondary CIDR block. |
subnet |
String |
Network ID of the subnet used to create a master node. Methods:
|
SecurityGroup |
String |
Default worker node security group ID of the cluster. If specified, the cluster will be bound to the target security group. Otherwise, the system will automatically create a default worker node security group for you. The default worker node security group needs to allow access from certain ports to ensure normal communications. |
Parameter |
Type |
Description |
---|---|---|
mode |
String |
Container network model. Select one of the following possible values:
|
cidr |
String |
Container CIDR block. Recommended: 10.0.0.0/12-19, 172.16.0.0/16-19, or 192.168.0.0/16-19. If the selected CIDR block conflicts with existing ones, an error will be reported. Not editable after the cluster is created. (deprecated. A specified cidrs will make cidr invalid.) |
cidrs |
Array of ContainerCIDR objects |
List of container CIDR blocks. In clusters of v1.21 and later, the cidrs field is used. When the cluster network type is vpc-router, you can add multiple container CIDR blocks. In versions earlier than v1.21, if the cidrs field is used, the first CIDR element in the array is used as the container CIDR block. This parameter cannot be modified after the cluster is created. |
Parameter |
Type |
Description |
---|---|---|
cidr |
String |
Container CIDR block. Recommended: 10.0.0.0/12-19, 172.16.0.0/16-19, and 192.168.0.0/16-19 |
Parameter |
Type |
Description |
---|---|---|
eniSubnetId |
String |
IPv4 subnet ID of ENI subnet. (IPv6 is not supported and is being discarded.) You can obtain it in either of the following ways:
|
eniSubnetCIDR |
String |
ENI subnet CIDR (being discarded) |
subnets |
Array of NetworkSubnet objects |
List of IPv4 subnet IDs |
Parameter |
Type |
Description |
---|---|---|
subnetID |
String |
IPv4 subnet ID of the subnet for creating master nodes. Currently, IPv6 is not supported. You can obtain it in either of the following ways:
|
Parameter |
Type |
Description |
---|---|---|
mode |
String |
Cluster authentication mode.
|
authenticatingProxy |
AuthenticatingProxy object |
Configuration related to the authenticating_proxy mode. This field is mandatory when the authentication mode is authenticating_proxy. |
Parameter |
Type |
Description |
---|---|---|
ca |
String |
X509 CA certificate (Base64-encoded) configured in authenticating_proxy mode. This field is mandatory when the cluster authentication mode is authenticating_proxy. Maximum size: 1 MB |
cert |
String |
Client certificate issued by the X509 CA certificate configured in authenticating_proxy mode, which is used for authentication from kube-apiserver to the extended API server. (The value must be Base64-encoded.) This field is mandatory when the cluster authentication mode is authenticating_proxy. |
privateKey |
String |
Private key of the client certificate issued by the X509 CA certificate configured in authenticating_proxy mode, which is used for authentication from kube-apiserver to the extended API server. The private key used by the Kubernetes cluster does not support password encryption. Use an unencrypted private key. (The value must be Base64-encoded.) This field is mandatory when the cluster authentication mode is authenticating_proxy. |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Key.
|
value |
String |
Value.
|
Parameter |
Type |
Description |
---|---|---|
clusterAZ |
String |
AZ of master nodes in the cluster.
|
dssMasterVolumes |
String |
Whether the system and data disks of a master node use dedicated distributed storage. If this parameter is omitted or left unspecified, EVS disks are used by default. This parameter is mandatory for dedicated CCE clusters. It is in the following format: <rootVol.dssPoolID>.<rootVol.volType>;<dataVol.dssPoolID>.<dataVol.volType> Field description:
Example: c950ee97-587c-4f24-8a74-3367e3da570f.sas;6edbc2f4-1507-44f8-ac0d-eed1d2608d38.ssd
NOTE:
This field cannot be configured for non-dedicated CCE clusters. |
enterpriseProjectId |
String |
ID of the enterprise project that a cluster belongs to.
NOTE:
|
kubeProxyMode |
String |
Service forwarding mode. Two modes are available:
NOTE:
This parameter has been deprecated. If this parameter and kubeProxyMode in ClusterSpec are specified at the same time, the latter is used. |
clusterExternalIP |
String |
EIP of the master node |
alpha.cce/fixPoolMask |
String |
Number of mask bits of the fixed IP address pool of the container network model. This field is supported only for the VPC network model (vpc-router). This parameter determines the number of container IP addresses that can be allocated to a node. The maximum number of pods that can be created on a node is decided by this parameter and maxPods set during node creation. For details, see Maximum Number of Pods That Can Be Created on a Node. For integer characters, the value ranges from 24 to 28. |
decMasterFlavor |
String |
Specifications of the master node in the dedicated hybrid cluster. |
dockerUmaskMode |
String |
Default UmaskMode configuration of Docker in a cluster. The value can be secure or normal. If this parameter is not specified, normal is used by default. |
kubernetes.io/cpuManagerPolicy |
String |
Cluster CPU management policy. The value can be none or static. Defaults to none.
|
upgradefrom |
String |
Records of how the cluster is upgraded to the current version |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Component name. |
configurations |
Array of ConfigurationItem objects |
Component configuration item. |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Component configuration item name. |
value |
Object |
Component configuration item value. |
Parameter |
Type |
Description |
---|---|---|
phase |
String |
Cluster status. Possible values:
|
jobID |
String |
Job ID. |
reason |
String |
Reason of cluster state change. This parameter is returned if the cluster is not in the Available state. |
message |
String |
Detailed information about why the cluster changes to the current state. This parameter is returned if the cluster is not in the Available state. |
endpoints |
Array of ClusterEndpoints objects |
Access address of kube-apiserver in the cluster. |
deleteOption |
Object |
Whether to delete configurations. This parameter is contained only in the response to the deletion request. |
deleteStatus |
Object |
Whether to delete the status information. This parameter is contained only in the response to the deletion request. |
Example Requests
None
Example Responses
Status code: 200
Information about the specified cluster is successfully obtained.
{ "kind" : "Cluster", "apiVersion" : "v3", "metadata" : { "name" : "mycluster", "uid" : "4d1ecb2c-229a-11e8-9c75-0255ac100ceb", "creationTimestamp" : "2018-08-02 03:48:58.968214406 +0000 UTC", "updateTimestamp" : "2018-08-02 04:05:29.386391813 +0000 UTC" }, "spec" : { "type" : "VirtualMachine", "flavor" : "cce.s1.small", "version" : "v1.7.3-r13", "description" : "this is a demo cluster", "customSan" : [ "192.168.1.0", "example.com" ], "hostNetwork" : { "vpc" : "4d1ecb2c-229a-11e8-9c75-0255ac100ceb", "subnet" : "4d1ecb2c-229a-11e8-9c75-0255ac100ceb" }, "containerNetwork" : { "mode" : "overlay_l2", "cidr" : "172.16.0.0/16" }, "authentication" : { "mode" : "x509", "authenticatingProxy" : { } }, "billingMode" : 0 }, "status" : { "phase" : "Available", "endpoints" : [ { "url" : "https://192.168.0.11:5443", "type" : "Internal" } ] } }
Status Codes
Status Code |
Description |
---|---|
200 |
Information about the specified cluster is successfully obtained. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot