Cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.
-Cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by Application/json.
-- The URL of APIs described in Cluster Management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path. Use X-Auth-Token as a header.
- The URL of Kubernetes-native APIs described in Add-on Management and Kubernetes APIs is in the format of https://{clusterid}.Endpoint/uri. In the URL, {clusterid} indicates a cluster ID, and uri indicates the resource path, that is, the API access path. Use X-Auth-Token as a header.
- The URL of Kubernetes-native APIs is in the format of https://{publicip}:5443/uri. In the URL, {publicip} indicates EIP of the cluster, and uri indicates the resource path, that is, the API access path. Use X-Remote-User or Authorization as a header.Before using X-Remote-User as a header, obtain the required certificate in advance. Two types of certificates are supported:
- Self-owned certificate uploaded during cluster creation. For details, see Creating a Cluster.
-
- Cluster certificate generated and downloaded after cluster creation. For details, see Obtaining a Cluster Certificate.
+
diff --git a/docs/cce/api-ref/cce_02_0239.html b/docs/cce/api-ref/cce_02_0239.html index 306eaf17..3bbd94fd 100644 --- a/docs/cce/api-ref/cce_02_0239.html +++ b/docs/cce/api-ref/cce_02_0239.html @@ -48,7 +48,7 @@Cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.
+Cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by Application/json.
+- The URL of APIs described in Cluster Management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path. Use X-Auth-Token as a header.
- The URL of Kubernetes-native APIs described in Add-on Management and Kubernetes APIs is in the format of https://{clusterid}.Endpoint/uri. In the URL, {clusterid} indicates a cluster ID, and uri indicates the resource path, that is, the API access path. Use X-Auth-Token as a header.
- The URL of Kubernetes-native APIs is in the format of https://{publicip}:5443/uri. In the URL, {publicip} indicates EIP of the cluster, and uri indicates the resource path, that is, the API access path. Use X-Remote-User or Authorization as a header.Before using X-Remote-User as a header, obtain the required certificate in advance. Two types of certificates are supported:
- Self-owned certificate uploaded during cluster creation. For details, see Creating a Cluster.
+
+
- Cluster certificate generated and downloaded after cluster creation. For details, see Obtaining a Cluster Certificate.
+
- Self-owned certificate uploaded during cluster creation. For details, see Creating a Cluster.
+
For details about how to use APIs, see API Usage Guidelines.
-CCE provides two methods to authenticate requests for calling an API: token and AK/SK. Select an authentication method based on actual requirements. If token-based authentication is used, you can call service APIs by using either of the following methods after obtaining a token:
-- Method 1: Add X-Auth-Token to the request header and set X-Auth-Token: ${token} with the obtained IAM token.
- Method 2: Add Authorization to the request header and set Authorization: Bearer ${token} with the obtained IAM token or token from Kubernetes service account.
- Method 3: Add X-Remote-User to the request header and set X-Remote-User: user with a valid certificate.
diff --git a/docs/cce/api-ref/cce_02_0238.html b/docs/cce/api-ref/cce_02_0238.html index 46420d97..85bb8d49 100644 --- a/docs/cce/api-ref/cce_02_0238.html +++ b/docs/cce/api-ref/cce_02_0238.html @@ -55,7 +55,7 @@
diff --git a/docs/cce/api-ref/cce_02_0236.html b/docs/cce/api-ref/cce_02_0236.html index 3ff7d5a0..c680f630 100644 --- a/docs/cce/api-ref/cce_02_0236.html +++ b/docs/cce/api-ref/cce_02_0236.html @@ -56,7 +56,7 @@Method 3 requires that the CA root certificate must has been uploaded before you create a cluster on the CCE console.
+For details about how to use APIs, see API Usage Guidelines.
+CCE provides two methods to authenticate requests for calling an API: token and AK/SK. Select an authentication method based on actual requirements. If token-based authentication is used, you can call service APIs by using either of the following methods after obtaining a token:
+- Method 1: Add X-Auth-Token to the request header and set X-Auth-Token: ${token} with the obtained IAM token.
- Method 2: Add Authorization to the request header and set Authorization: Bearer ${token} with the obtained IAM token or token from Kubernetes service account.
- Method 3: Add X-Remote-User to the request header and set X-Remote-User: user with a valid certificate.
Method 3 requires that the CA root certificate must has been uploaded before you create a cluster on the CCE console.
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 on how to obtain a user token, see API Usage Guidelines.
+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 on how to obtain a user token, see API Usage Guidelines.
If the cluster will span across AZs or belong to a specified enterprise project, set extended fields as described in Table 13.
+enableMasterVolumeEncryption
+No
+Boolean
+The system disks and data disks of the master nodes in the cluster are encrypted. By default, the AES-256 encryption algorithm is used. This function is available in both CCE standard and Turbo clusters of v1.25 and later versions. The configuration cannot be modified after the cluster is created. After this function is enabled, there is some disk I/O performance loss.
+Yes
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 on how to obtain a user token, see API Usage Guidelines.
+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 on how to obtain a user token, see API Usage Guidelines.
- 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 a latency and even obvious performance issues in the case of heavy service traffic.
- ipvs: Optimized kube-proxy mode with higher throughput and faster speed. This mode supports incremental updates and can keep connections uninterrupted during service updates. It is suitable for large-sized clusters.
enableMasterVolumeEncryption
+Boolean
+The system disks and data disks of the master nodes in the cluster are encrypted. By default, the AES-256 encryption algorithm is used. This function is available in both CCE standard and Turbo clusters of v1.25 and later versions. The configuration cannot be modified after the cluster is created. After this function is enabled, there is some disk I/O performance loss.
+Yes
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 on how to obtain a user token, see API Usage Guidelines.
+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 on how to obtain a user token, see API Usage Guidelines.
Yes
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 on how to obtain a user token, see API Usage Guidelines.
+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 on how to obtain a user token, see API Usage Guidelines.
Yes
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 on how to obtain a user token, see API Usage Guidelines.
+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 on how to obtain a user token, see API Usage Guidelines.
Yes
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 on how to obtain a user token, see API Usage Guidelines.
+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 on how to obtain a user token, see API Usage Guidelines.
Integer
Specifies the system disk size, in GB. The value ranges from 40 to 1024.
+Disk size, in GB.
+Value range for system disks: 40 to 1024. Value range for data disks: 100 to 32768.
extendParam
diff --git a/docs/cce/api-ref/cce_02_0243.html b/docs/cce/api-ref/cce_02_0243.html index 4a173579..7452b0ca 100644 --- a/docs/cce/api-ref/cce_02_0243.html +++ b/docs/cce/api-ref/cce_02_0243.html @@ -87,7 +87,7 @@Yes
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 on how to obtain a user token, see API Usage Guidelines.
+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 on how to obtain a user token, see API Usage Guidelines.
Yes
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 on how to obtain a user token, see API Usage Guidelines.
+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 on how to obtain a user token, see API Usage Guidelines.
Yes
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 on how to obtain a user token, see API Usage Guidelines.
+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 on how to obtain a user token, see API Usage Guidelines.
Yes
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 on how to obtain a user token, see API Usage Guidelines.
+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 on how to obtain a user token, see API Usage Guidelines.
Yes
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 on how to obtain a user token, see API Usage Guidelines.
+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 on how to obtain a user token, see API Usage Guidelines.
Maximum: 16384
Yes
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 on how to obtain a user token, see API Usage Guidelines.
+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 on how to obtain a user token, see API Usage Guidelines.
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 on how to obtain a user token, see API Usage Guidelines.
+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 on how to obtain a user token, see API Usage Guidelines.
Maximum: 16384
2023-11-06
+2024-03-29
- Added the customSecurityGroups field. For details, see Table 5.
- Added Node Flavor Description.
- Added the enableMasterVolumeEncryption field in Table 5.
- Updated API Usage Guidelines.
2023-11-06
+- Added the customSecurityGroups field. For details, see Table5 Data structure of the spec field.
- Added Node Flavor Description.
2023-02-10
@@ -45,7 +50,7 @@2020-09-04
Updated API Usage Guidelines.
+Updated API Usage Guidelines.
2020-08-31
@@ -60,12 +65,12 @@2020-05-08
- Updated API Usage Guidelines.
- Added alpha.cce/fixPoolMask, kubernetes.io/cpuManagerPolicy, and upgradefrom in Table 13.
- Added ipv6enable and eniNetwork in Table 16.
- Added SecurityGroup in Table 17.
- Added ipv6enable and eniNetwork in Table 4.
- Added Table 6 in Reading a Specified Node.
- Added extendParam in Table 10.
- Updated Table 19.
- Updated os in Table 5.
- Updated the request and response examples in Cluster Management.
- Updated API Usage Guidelines.
- Added alpha.cce/fixPoolMask, kubernetes.io/cpuManagerPolicy, and upgradefrom in Table 13.
- Added ipv6enable and eniNetwork in Table 16.
- Added SecurityGroup in Table 17.
- Added ipv6enable and eniNetwork in Table 4.
- Added Table 6 in Reading a Specified Node.
- Added extendParam in Table 10.
- Updated Table 19.
- Updated os in Table 5.
- Updated the request and response examples in Cluster Management.
2020-04-14
- Updated API Usage Guidelines.
- Added kubeProxyMode in Table 5.
- Added authenticatingProxy in Table 7.
- Added clusterExternalIP and deleted kubeProxyMode in Table 13.
- Updated the example request in Creating a Cluster.
- Updated extendParam in Table 21.
- Updated spec in Table 3.
- Added description in Table 4.
- Deleted patchVersion in Table 10.
- Added publicKey in Table 28.
- Added initialNodeCount in Table 6.
- Added minNodeCount in Table 17.
- Updated Table 19.
- Updated API Usage Guidelines.
- Added kubeProxyMode in Table 5.
- Added authenticatingProxy in Table 7.
- Added clusterExternalIP and deleted kubeProxyMode in Table 13.
- Updated the example request in Creating a Cluster.
- Updated extendParam in Table 21.
- Updated spec in Table 3.
- Added description in Table 4.
- Deleted patchVersion in Table 10.
- Added publicKey in Table 28.
- Added initialNodeCount in Table 6.
- Added minNodeCount in Table 17.
- Updated Table 19.
2020-03-25
@@ -75,12 +80,12 @@2020-02-27
- Updated API Usage Guidelines.
- Deleted the description of Add-on Management APIs.
- Updated API Usage Guidelines.
- Deleted the description of Add-on Management APIs.
2020-02-25
Updated API Usage Guidelines.
+Updated API Usage Guidelines.
2020-02-24
@@ -105,7 +110,7 @@2019-11-20
Updated API Usage Guidelines.
+Updated API Usage Guidelines.
2019-11-12
@@ -115,7 +120,7 @@2019-10-30
- Revised descriptions to indicate support for creating Kubernetes clusters 1.13.10.
- Updated API Usage Guidelines.
- Revised descriptions to indicate support for creating Kubernetes clusters 1.13.10.
- Updated API Usage Guidelines.
2019-08-21
diff --git a/docs/cce/api-ref/cce_02_0321.html b/docs/cce/api-ref/cce_02_0321.html index 03eb99ea..0e0bce57 100644 --- a/docs/cce/api-ref/cce_02_0321.html +++ b/docs/cce/api-ref/cce_02_0321.html @@ -52,7 +52,7 @@Yes
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 on how to obtain a user token, see API Usage Guidelines.
+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 on how to obtain a user token, see API Usage Guidelines.
Maximum: 16384
Yes
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 on how to obtain a user token, see API Usage Guidelines.
+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 on how to obtain a user token, see API Usage Guidelines.
Yes
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 on how to obtain a user token, see API Usage Guidelines.
+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 on how to obtain a user token, see API Usage Guidelines.
Yes
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 on how to obtain a user token, see API Usage Guidelines.
+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 on how to obtain a user token, see API Usage Guidelines.
Yes
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 on how to obtain a user token, see API Usage Guidelines.
+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 on how to obtain a user token, see API Usage Guidelines.
Yes
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 on how to obtain a user token, see API Usage Guidelines.
+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 on how to obtain a user token, see API Usage Guidelines.
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 on how to obtain a user token, see API Usage Guidelines.
+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 on how to obtain a user token, see API Usage Guidelines.
Integer
Specifies the system disk size, in GB. The value ranges from 40 to 1024.
+Disk size, in GB.
+Value range for system disks: 40 to 1024. Value range for data disks: 100 to 32768.
extendParam
diff --git a/docs/cce/api-ref/cce_02_0355.html b/docs/cce/api-ref/cce_02_0355.html index 70c453c4..e2eb17b9 100644 --- a/docs/cce/api-ref/cce_02_0355.html +++ b/docs/cce/api-ref/cce_02_0355.html @@ -123,7 +123,7 @@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 on how to obtain a user token, see API Usage Guidelines.
+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 on how to obtain a user token, see API Usage Guidelines.
Integer
Specifies the system disk size, in GB. The value ranges from 40 to 1024.
+Disk size, in GB.
+Value range for system disks: 40 to 1024. Value range for data disks: 100 to 32768.
extendParam
diff --git a/docs/cce/api-ref/cce_02_0356.html b/docs/cce/api-ref/cce_02_0356.html index 9761002d..5a5baac1 100644 --- a/docs/cce/api-ref/cce_02_0356.html +++ b/docs/cce/api-ref/cce_02_0356.html @@ -70,7 +70,7 @@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 on how to obtain a user token, see API Usage Guidelines.
+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 on how to obtain a user token, see API Usage Guidelines.
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 on how to obtain a user token, see API Usage Guidelines.
+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 on how to obtain a user token, see API Usage Guidelines.
Yes
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 on how to obtain a user token, see API Usage Guidelines.
+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 on how to obtain a user token, see API Usage Guidelines.
String
Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this field is mandatory and must be set to a user token. For details about how to obtain a token, see API Usage Guidelines.
+Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this field is mandatory and must be set to a user token. For details about how to obtain a token, see API Usage Guidelines.
Maximum: 16384
String
Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this field is mandatory and must be set to a user token. For details about how to obtain a token, see API Usage Guidelines.
+Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this field is mandatory and must be set to a user token. For details about how to obtain a token, see API Usage Guidelines.
Maximum: 16384
- Self-owned certificate uploaded during cluster creation. For details, see Creating a Cluster.