nodes
|
Yes
@@ -274,23 +283,49 @@
-Table 7 NodeItemParameter
+Table 7 RuntimeParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-uid
+ | name
|
-Yes
+ | No
|
-String
+ | String
|
-Node ID.
+ | Container runtime:
+- Clusters of v1.25 or earlier: docker.
- Clusters of v1.25 or later: Container runtime varies with the OS. For nodes running EulerOS 2.5, the default container runtime is docker. For nodes running other OSs, the default container runtime is containerd.
+Enumeration values:
+
+ |
+
+
+
+ Table 8 NodeItemParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+uid
+ |
+Yes
+ |
+String
+ |
+Node ID.
|
@@ -299,7 +334,7 @@
Response ParametersStatus code: 200
- Table 8 Response body parametersParameter
+Table 9 Response body parametersParameter
|
Type
|
@@ -339,7 +374,7 @@
|---|
Table 9 MigrateNodesSpecParameter
+Table 10 MigrateNodesSpecParameter
|
Type
|
@@ -379,7 +414,7 @@
|---|
Table 10 MigrateNodeExtendParamParameter
+Table 11 MigrateNodeExtendParamParameter
|
Type
|
@@ -435,7 +470,7 @@
|---|
Table 11 LoginParameter
+Table 12 LoginParameter
|
Type
|
@@ -463,7 +498,7 @@
|---|
Table 12 NodeItemParameter
+Table 13 NodeItemParameter
|
Type
|
@@ -482,7 +517,7 @@
|---|
Table 13 TaskStatusParameter
+Table 14 TaskStatusParameter
|
Type
|
diff --git a/docs/cce/api-ref/cce_02_0092.html b/docs/cce/api-ref/cce_02_0092.html
index d4cfa127c..8c6b4c47d 100644
--- a/docs/cce/api-ref/cce_02_0092.html
+++ b/docs/cce/api-ref/cce_02_0092.html
@@ -20,7 +20,7 @@
Obtaining Cluster Certificates
-Obtaining Cluster Certificates (Deprecated)
+Obtaining Cluster Certificates (Deprecated)
Creating a Node
diff --git a/docs/cce/api-ref/cce_02_0344.html b/docs/cce/api-ref/cce_02_0344.html
index 88436c5b3..5ec256ca2 100644
--- a/docs/cce/api-ref/cce_02_0344.html
+++ b/docs/cce/api-ref/cce_02_0344.html
@@ -3,15 +3,15 @@
API Usage Guidelines
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.
+- 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:
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. For details, see Cluster Management Permission Control.
+ Method 3 requires that the CA root certificate must has been uploaded before you create a cluster on the CCE console.
diff --git a/docs/cce/api-ref/cce_02_0359.html b/docs/cce/api-ref/cce_02_0359.html
new file mode 100644
index 000000000..6563c7af6
--- /dev/null
+++ b/docs/cce/api-ref/cce_02_0359.html
@@ -0,0 +1,347 @@
+
+
+ Obtaining Cluster Certificates (Deprecated)
+ FunctionThis API is used to obtain certificates of a specified cluster in form of kubeconfig file.
+
+ URIGET /api/v3/projects/{project_id}/clusters/{cluster_id}/clustercert
+ Table 1 describes the parameters of this API.
+
+
+
+ RequestRequest parameters:
+ Table 2 describes the request parameters.
+
+ Table 2 Parameters in the request headerParameter
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+Content-Type
+ |
+Yes
+ |
+Message body type (format). Possible values:
+- application/json;charset=utf-8
- application/json
+ |
+
+X-Auth-Token
+ |
+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.
+ |
+
+
+
+
+ Example request:
+ N/A
+
+ ResponseResponse parameters:
+ Table 3 describes the response parameters.
+
+ Table 3 Response parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+kind
+ |
+String
+ |
+API type. The value is fixed at Config and cannot be changed.
+ |
+
+apiVersion
+ |
+String
+ |
+API version. The value is fixed at v1 and cannot be changed.
+ |
+
+preferences
+ |
+-
+ |
+This field is not used currently and is left unspecified by default.
+ |
+
+clusters
+ |
+clusters object
+ |
+Cluster list.
+ |
+
+users
+ |
+users object
+ |
+-
+ |
+
+contexts
+ |
+contexts object
+ |
+Context list.
+ |
+
+current-context
+ |
+String
+ |
+Current context.
+ |
+
+
+
+
+
+
+ Table 4 Data structure of the clusters fieldParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+name
+ |
+String
+ |
+Cluster name.
+- If the publicIp parameter does not exist (that is, no EIP exists), there is only one cluster in the cluster list, and the value of this parameter is internalCluster.
- If the publicIp parameter exists (that is, the EIP exists), there is more than one cluster in the cluster list, and the value of this parameter is externalCluster.
+ |
+
+cluster
+ |
+cluster object
+ |
+Cluster information.
+ |
+
+
+
+
+
+ Table 5 Data structure of the cluster fieldParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+server
+ |
+String
+ |
+Node IP address.
+ |
+
+certificate-authority-data
+ |
+String
+ |
+Certificate authorization data.
+ |
+
+
+
+
+
+ Table 6 Data structure of the users fieldParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+name
+ |
+String
+ |
+The value is fixed to user.
+ |
+
+user
+ |
+user object
+ |
+Stores the certificate information and ClientKey information of a specified user.
+ |
+
+
+
+
+
+ Table 7 Data structure of the user fieldParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+client-certificate-data
+ |
+String
+ |
+Client certificate.
+ |
+
+client-key-data
+ |
+String
+ |
+Contains PEM encoding data from the TLS client key file.
+ |
+
+
+
+
+
+ Table 8 Data structure of the contexts fieldParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+name
+ |
+String
+ |
+Context name.
+- If the publicIp parameter does not exist (that is, no EIP exists), there is only one cluster in the cluster list, and the value of this parameter is internal.
- If the publicIp parameter exists (that is, the EIP exists), there is more than one cluster in the cluster list, and the value of this parameter is external.
+ |
+
+context
+ |
+context object
+ |
+Context information.
+ |
+
+
+
+
+
+ Table 9 Data structure of the context fieldParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+cluster
+ |
+String
+ |
+Cluster context.
+ |
+
+user
+ |
+String
+ |
+User context.
+ |
+
+
+
+
+ Response example:
+ {
+ "kind": "Config",
+ "apiVersion": "v1",
+ "preferences": {},
+ "clusters": [
+ {
+ "name": "internalCluster",
+ "cluster": {
+ "server": "https://192.168.1.7:5443",
+ "certificate-authority-data": ""
+ }
+ }
+ ],
+ "users": [
+ {
+ "name": "user",
+ "user": {
+ "client-certificate-data": "",
+ "client-key-data": ""
+ }
+ }
+ ],
+ "contexts": [
+ {
+ "name": "internal",
+ "context": {
+ "cluster": "internalCluster",
+ "user": "user"
+ }
+ }
+ ],
+ "current-context": "internal"
+}
+ Status CodeTable 10 describes the status code of this API.
+
+ Table 10 Status codeStatus Code
+ |
+Description
+ |
+
|---|
+
+200
+ |
+Certificates of the specified cluster are successfully obtained.
+ |
+
+
+
+
+ For details about error status codes, see Status Code.
+
+
+
+
diff --git a/docs/cce/api-ref/cce_02_0359_0.html b/docs/cce/api-ref/cce_02_0359_0.html
deleted file mode 100644
index 2304c5646..000000000
--- a/docs/cce/api-ref/cce_02_0359_0.html
+++ /dev/null
@@ -1,347 +0,0 @@
-
-
- Obtaining Cluster Certificates (Deprecated)
- FunctionThis API is used to obtain certificates of a specified cluster in form of kubeconfig file.
-
- URIGET /api/v3/projects/{project_id}/clusters/{cluster_id}/clustercert
- Table 1 describes the parameters of this API.
-
-
-
- RequestRequest parameters:
- Table 2 describes the request parameters.
-
- Table 2 Parameters in the request headerParameter
- |
-Mandatory
- |
-Description
- |
-
|---|
-
-Content-Type
- |
-Yes
- |
-Message body type (format). Possible values:
-- application/json;charset=utf-8
- application/json
- |
-
-X-Auth-Token
- |
-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.
- |
-
-
-
-
- Example request:
- N/A
-
- ResponseResponse parameters:
- Table 3 describes the response parameters.
-
- Table 3 Response parametersParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-kind
- |
-String
- |
-API type. The value is fixed at Config and cannot be changed.
- |
-
-apiVersion
- |
-String
- |
-API version. The value is fixed at v1 and cannot be changed.
- |
-
-preferences
- |
--
- |
-This field is not used currently and is left unspecified by default.
- |
-
-clusters
- |
-clusters object
- |
-Cluster list.
- |
-
-users
- |
-users object
- |
--
- |
-
-contexts
- |
-contexts object
- |
-Context list.
- |
-
-current-context
- |
-String
- |
-Current context.
- |
-
-
-
-
-
-
- Table 4 Data structure of the clusters fieldParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-name
- |
-String
- |
-Cluster name.
-- If the publicIp parameter does not exist (that is, no EIP exists), there is only one cluster in the cluster list, and the value of this parameter is internalCluster.
- If the publicIp parameter exists (that is, the EIP exists), there is more than one cluster in the cluster list, and the value of this parameter is externalCluster.
- |
-
-cluster
- |
-cluster object
- |
-Cluster information.
- |
-
-
-
-
-
- Table 5 Data structure of the cluster fieldParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-server
- |
-String
- |
-Node IP address.
- |
-
-certificate-authority-data
- |
-String
- |
-Certificate authorization data.
- |
-
-
-
-
-
- Table 6 Data structure of the users fieldParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-name
- |
-String
- |
-The value is fixed to user.
- |
-
-user
- |
-user object
- |
-Stores the certificate information and ClientKey information of a specified user.
- |
-
-
-
-
-
- Table 7 Data structure of the user fieldParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-client-certificate-data
- |
-String
- |
-Client certificate.
- |
-
-client-key-data
- |
-String
- |
-Contains PEM encoding data from the TLS client key file.
- |
-
-
-
-
-
- Table 8 Data structure of the contexts fieldParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-name
- |
-String
- |
-Context name.
-- If the publicIp parameter does not exist (that is, no EIP exists), there is only one cluster in the cluster list, and the value of this parameter is internal.
- If the publicIp parameter exists (that is, the EIP exists), there is more than one cluster in the cluster list, and the value of this parameter is external.
- |
-
-context
- |
-context object
- |
-Context information.
- |
-
-
-
-
-
- Table 9 Data structure of the context fieldParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-cluster
- |
-String
- |
-Cluster context.
- |
-
-user
- |
-String
- |
-User context.
- |
-
-
-
-
- Response example:
- {
- "kind": "Config",
- "apiVersion": "v1",
- "preferences": {},
- "clusters": [
- {
- "name": "internalCluster",
- "cluster": {
- "server": "https://192.168.1.7:5443",
- "certificate-authority-data": ""
- }
- }
- ],
- "users": [
- {
- "name": "user",
- "user": {
- "client-certificate-data": "",
- "client-key-data": ""
- }
- }
- ],
- "contexts": [
- {
- "name": "internal",
- "context": {
- "cluster": "internalCluster",
- "user": "user"
- }
- }
- ],
- "current-context": "internal"
-}
- Status CodeTable 10 describes the status code of this API.
-
- Table 10 Status codeStatus Code
- |
-Description
- |
-
|---|
-
-200
- |
-Certificates of the specified cluster are successfully obtained.
- |
-
-
-
-
- For details about error status codes, see Status Code.
-
-
-
-
diff --git a/docs/cce/api-ref/kubernetesapi.html b/docs/cce/api-ref/kubernetesapi.html
index d54e1c31f..c99710beb 100644
--- a/docs/cce/api-ref/kubernetesapi.html
+++ b/docs/cce/api-ref/kubernetesapi.html
@@ -1,14 +1,11 @@
Overview
- DescriptionYou can use Kubernetes native APIs to manage your Kubernetes clusters. For details, see Kubernetes API Concepts.
- To find detailed API definitions for different Kubernetes versions, visit the following links:
-
- Based on the open source Kubernetes APIs, CCE enhances and adapts following functions.
-
+ DescriptionKubernetes APIs are resource-based (RESTful) programming interfaces provided through HTTP. It supports query, creation, update, and deletion of various cluster resources using standard HTTP request methods (POST, PUT, PATCH, DELETE, and GET).
+ CCE allows you to use native Kubernetes APIs in the following ways:
+
- Calling Kubernetes APIs Through API GatewayYou can call Kubernetes native APIs through API Gateway using the URL in the format of https://{clusterid}.Endpoint/uri. In the URL, {clusterid} indicates the cluster ID, and uri indicates the resource path, that is, the path for API access.
+ Calling Kubernetes APIs Through API GatewayYou can call Kubernetes native APIs through API Gateway using the URL in the format of https://{clusterid}.Endpoint/uri. In the URL, {clusterid} indicates the cluster ID, and uri indicates the resource path, that is, the path for API access.
Table 1 URL parametersParameter
|
@@ -35,7 +32,7 @@
|---|
- Calling Kubernetes APIs Through the API ServerYou can use the API server of a Kubernetes cluster to call Kubernetes native APIs.
+ Calling Kubernetes APIs Through the API ServerYou can use the API server of a Kubernetes cluster to call Kubernetes native APIs.
- Call the API for obtaining the cluster certificate to obtain the cluster certificates.
There are three certificates:
- ca.crt
- client.crt
- client.key
- Go to the cluster details page and obtain the API server address (private or public network address).
With the certificates and API server address, you can call Kubernetes native APIs.
diff --git a/docs/cce/api-ref/node_storage_example.html b/docs/cce/api-ref/node_storage_example.html
index 00f5df155..78fc422cf 100644
--- a/docs/cce/api-ref/node_storage_example.html
+++ b/docs/cce/api-ref/node_storage_example.html
@@ -66,7 +66,7 @@ vgcreate ${vgName} ${storageDevice}
"login": {
"userPassword": {
"username": "root",
- "password": "JDYkbzhEbE90ckIkY1c0SWJzRy9WeVIzcDFVbC41NFVqa1pxenE0bW9naERlS2RCWEIyWlhqSlpWSjJrL2NmcmdWeE12NGh4T25DeDhlMTdrREVSM2dicHdZNmYzZXh5dy4="
+ "password": "******"
}
},
"storage": {
@@ -152,7 +152,7 @@ vgcreate ${vgName} ${storageDevice}
"login": {
"userPassword": {
"username": "root",
- "password": "JDYkRmJPckIwRkMkR3RXTkFsNmYvNlAxSDdOTUhYSHZmWjQ0b0ttODRzTDk0L1NzMzRIaHBsQVJkRTZiOGI0WTVJbUtSLlF5aTAuTUpwbGZqdHBTdkYxOU9peGZPV2FUYi4="
+ "password": "******"
}
},
"storage": {
@@ -263,7 +263,7 @@ vgcreate ${vgName} ${storageDevice}
"login": {
"userPassword": {
"username": "root",
- "password": "JDYkbzhEbE90ckIkY1c0SWJzRy9WeVIzcDFVbC41NFVqa1pxenE0bW9naERlS2RCWEIyWlhqSlpWSjJrL2NmcmdWeE12NGh4T25DeDhlMTdrREVSM2dicHdZNmYzZXh5dy4="
+ "password": "******"
}
},
"storage": {
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|