Call the DescribeClusterUserKubeconfig API to get a user kubeconfig - Container Service for Kubernetes - Alibaba Cloud - Container Service for Kubernetes

Operation description

The default validity period of a certificate issued for a kubeconfig file is three years. Within 180 days before expiration, you can obtain a refreshed kubeconfig file with rotated certificates through the Container Service for Kubernetes console or by calling the API operation to retrieve the cluster kubeconfig. The new kubeconfig certificate remains valid for three years. The old kubeconfig credentials remain valid until the certificate expires. Obtain the rotated credentials promptly based on the kubeconfig expiration time displayed in the console or returned by the API operation.
Properly manage the kubeconfig credentials for cluster management and revoke them promptly when they are no longer needed to prevent security risks such as data leaks caused by kubeconfig exposure.

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

cs:DescribeClusterUserKubeconfig

get

*Cluster

acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

cs:KubeConfigDurationMinutes

None

Request syntax

GET /k8s/{ClusterId}/user_config HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The ID of the cluster.	c5b5e80b0b64a4bf6939d2d8fbbc5****

Request parameters

Parameter	Type	Required	Description	Example
PrivateIpAddress	boolean	No	Specifies whether to obtain the internal network connection configuration. Valid values: `true`: obtains only the internal network connection credentials. `false`: obtains only the public network connection credentials. Default value: `false`.	false
TemporaryDurationMinutes	integer	No	The validity period of the temporary kubeconfig file, in minutes. Valid values: 15 to 4320. Note If you do not specify this parameter, the system automatically determines a longer validity period. You can determine the specific expiration time based on the value of the `expiration` field in the response.	15

Response elements

Element	Type	Description	Example
	object	The response body.
config	string	The kubeconfig file of the cluster.	apiVersion: v1\nclusters:\n- cluster:\n server: https://114.55.xx.xx:6443\n certificate-authority-data: LS0tLS****
expiration	string	The expiration time of the kubeconfig file. The time is displayed in UTC and follows the RFC 3339 standard.	2024-03-10T09:56:17Z

Examples

Success response

JSON format

{
  "config": "apiVersion: v1\\nclusters:\\n- cluster:\\n    server: https://114.55.xx.xx:6443\\n    certificate-authority-data: LS0tLS****",
  "expiration": "2024-03-10T09:56:17Z"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.