DescribeSubaccountK8sClusterUserConfig - Container Service for Kubernetes

Queries or issues the kubeconfig credentials of a Resource Access Management (RAM) user or RAM role of the account. If you are the permission manager of a Container Service for Kubernetes (ACK) cluster, you can issue the kubeconfig credentials to a specific RAM user or RAM role of the account by using the Alibaba Cloud account. The kubeconfig credentials, which are used to connect to the ACK cluster, contain the identity information about the RAM user or RAM role.

Operation description

****Only Alibaba Cloud accounts can call this API operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cs:DescribeSubaccountK8sClusterUserConfig	get	Cluster acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The cluster ID.	c5b5e80b0b64a4bf6939d2d8f****
Uid	string	Yes	The ID of the RAM user or RAM role whose cluster kubeconfig file that you want to obtain.	26562443851650****
PrivateIpAddress	boolean	No	Specifies whether to obtain the kubeconfig file used to connect to the cluster over the internal network. Valid values: `true`: Obtain the kubeconfig file used to connect to the cluster over the internal network. `false`: Obtain the kubeconfig file used to connect to the cluster over the Internet. Default value: `false`.	true
TemporaryDurationMinutes	long	No	The validity period of the temporary kubeconfig file. Unit: minutes. Valid values: 15 to 4320 (three days). Note If you leave this parameter empty, the system sets a longer validity period and returns the value in the expiration parameter of the response.	15

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
config	string	The cluster kubeconfig file. For more information about the content of the kubeconfig file, see Configure cluster credentials.	apiVersion: v1****
expiration	string	The expiration date of the kubeconfig file. The value is the UTC time displayed in RFC3339 format.	2024-03-10T09:56:17Z

Examples

Sample success responses

JSONformat

{
  "config": "apiVersion: v1****",
  "expiration": "2024-03-10T09:56:17Z"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-08-15	The internal configuration of the API is changed, but the call is not affected	View Change Details