Obtaining the kubeconfig of a Cluster

Function

This API is used to obtain the kubeconfig of a cluster.

URI

POST /v1/clusters/{clusterid}/kubeconfig

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
clusterid	Yes	String	Cluster ID

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	Identity authentication information. 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.

Response Parameters

Status code: 201

**Table 3** Response body parameters
Parameter	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.
clusters	Array of NamedCluster objects	Cluster list
users	Array of NamedAuthInfo objects	Certificate information and client key information of a specified user
contexts	Array of NamedContext objects	Context list
current-context	String	Current context

**Table 4** NamedCluster
Parameter	Type	Description
name	String	Cluster name
cluster	ClusterCert object	Cluster information

**Table 5** ClusterCert
Parameter	Type	Description
server	String	Server address
certificate-authority-data	String	Certificate authorization data
insecure-skip-tls-verify	String	Whether to skip server certificate verification

**Table 6** NamedAuthInfo
Parameter	Type	Description
name	String	User name
user	AuthInfo object	Certificate information and client key information of a specified user

**Table 7** AuthInfo
Parameter	Type	Description
client-certificate-data	String	Client certificate
client-key-data	String	PEM encoding data from the TLS client key file
token	String	Authentication token

**Table 8** NamedContext
Parameter	Type	Description
name	String	Context name
context	Context object	Context information

**Table 9** Context
Parameter	Type	Description
cluster	String	Cluster context
user	String	User context

Status code: 400

**Table 10** Response body parameters
Parameter	Type	Description
-	String	-

Status code: 404

**Table 11** Response body parameters
Parameter	Type	Description
-	String	-

Status code: 500

**Table 12** Response body parameters
Parameter	Type	Description
-	String	-

Example Requests

Obtaining the kubeconfig of a specific cluster

POST https://ucs.myhuaweicloud.com/v1/clusters/{clusterid}/kubeconfig

Example Responses

Status code: 201

The kubeconfig of the cluster obtained

{
  "kind" : "Config",
  "apiVersion" : "v1",
  "clusters" : [ {
    "name" : "internalCluster",
    "cluster" : {
      "server" : "https://192.168.0.18:5443",
      "certificate-authority-data" : "*****"
    }
  }, {
    "name" : "externalCluster",
    "cluster" : {
      "server" : "https://100.93.8.56:5443",
      "insecure-skip-tls-verify" : true
    }
  }, {
    "name" : "externalClusterTLSVerify",
    "cluster" : {
      "server" : "https://100.93.8.56:5443",
      "certificate-authority-data" : "******"
    }
  } ],
  "users" : [ {
    "name" : "user",
    "user" : {
      "client-certificate-data" : "******",
      "client-key-data" : "******"
    }
  } ],
  "contexts" : [ {
    "name" : "internal",
    "context" : {
      "cluster" : "internalCluster",
      "user" : "user"
    }
  }, {
    "name" : "external",
    "context" : {
      "cluster" : "externalCluster",
      "user" : "user"
    }
  }, {
    "name" : "externalTLSVerify",
    "context" : {
      "cluster" : "externalClusterTLSVerify",
      "user" : "user"
    }
  } ],
  "current-context" : "external"
}

Status Codes

Status Code	Description
201	The kubeconfig of the cluster obtained
400	Client request error. The server could not execute the request.
404	Resources not found
500	Internal server error