DescribeClusterUserKubeconfig - ENS - Alibaba Cloud Documentation Center

A kubeconfig file contains the credentials required for a client to access an Elastic Container instance on Kubernetes (ECK) cluster. The file includes identity and authentication data for accessing the destination cluster. To manage a cluster using kubectl, you must first connect to the cluster with its kubeconfig file. You can call the DescribeClusterUserKubeconfig operation to query the kubeconfig file for a specific cluster.

Operation description

A single user is limited to 100 calls per second.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ens:DescribeClusterUserKubeconfig

get

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The cluster ID.	eck-xxxxxxxxx
PrivateIpAddress	boolean	No	Specifies whether to use the internal access address. The default value is false.	false

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	C0003E8B-B930-4F59-ADC0-0E209A9012A8
Config	any	The kubeconfig file of the cluster.	apiVersion: v1 clusters: - cluster: certificate-authority-data: x server: https://111.111.111.111:6443 name: kubernetes contexts: - context: cluster: kubernetes user: user name: eck-xxxxx current-context: eck-xxxx kind: Config preferences: {} users: - name: user user: client-certificate-data: x client-key-data: x

Examples

Success response

JSON format

{
  "RequestId": "C0003E8B-B930-4F59-ADC0-0E209A9012A8",
  "Config": "apiVersion: v1\nclusters:\n- cluster:\n    certificate-authority-data: x\n    server: https://111.111.111.111:6443\n  name: kubernetes\ncontexts:\n- context:\n    cluster: kubernetes\n    user: user\n  name: eck-xxxxx\ncurrent-context: eck-xxxx\nkind: Config\npreferences: {}\nusers:\n- name: user\n  user:\n    client-certificate-data: x\n    client-key-data: x"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.