DescribeClusterUserKubeconfig - Container Service for Kubernetes: Central de Documentação do Alibaba Cloud

Os arquivos kubeconfig armazenam informações de identidade e autenticação usadas por clientes para acessar clusters do Container Service for Kubernetes (ACK). Para usar um cliente kubectl para gerenciar um cluster ACK, você precisa usar o arquivo kubeconfig correspondente para se conectar ao cluster ACK. Recomendamos que você mantenha os arquivos kubeconfig confidenciais e revogue os arquivos kubeconfig que não estão em uso. Isso ajuda a prevenir vazamentos de dados causados pela divulgação de arquivos kubeconfig.

Descrição da operação

O período de validade padrão de um arquivo kubeconfig é de 3 anos. 180 dias antes de um arquivo kubeconfig expirar, você pode renová-lo no console do Container Service for Kubernetes (ACK) ou chamando operações de API. Após a renovação de um arquivo kubeconfig, o arquivo kubeconfig é válido por 3 anos. O arquivo kubeconfig anterior ainda permanece válido até a expiração. Recomendamos que você renove seu arquivo kubeconfig o mais cedo possível.
Recomendamos que você mantenha os arquivos kubeconfig confidenciais e revogue os arquivos kubeconfig que não estão em uso. Isso ajuda a prevenir vazamentos de dados causados pela divulgação de arquivos kubeconfig.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

cs:DescribeClusterUserKubeconfig

get

*Cluster

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

cs:KubeConfigDurationMinutes

Nenhuma

Sintaxe da solicitação

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

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ClusterId	string	Sim	O ID do cluster.	c5b5e80b0b64a4bf6939d2d8fbbc5****

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PrivateIpAddress	boolean	Não	Especifica se deve ser obtido o arquivo kubeconfig usado para se conectar ao cluster pela rede interna. Valores válidos: `true`: obtém o arquivo kubeconfig usado para se conectar à instância master pela rede interna. `false`: obtém o arquivo kubeconfig usado para se conectar à instância master pela Internet. Valor padrão: `false`	false
TemporaryDurationMinutes	integer	Não	O período de validade do arquivo kubeconfig temporário. Unidade: minutos. Valores válidos: 15 a 4320 (3 dias). Notas de uso** Se você não especificar este parâmetro, o sistema especifica um período de validade mais longo. O período de validade é retornado no parâmetro `expiration`.	15

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O corpo da resposta.
config	string	O arquivo kubeconfig do cluster.	apiVersion: v1\nclusters:\n- cluster:\n server: https://114.55.xx.xx:6443\n certificate-authority-data: LS0tLS****
expiration	string	O tempo de expiração do arquivo kubeconfig. Formato: horário UTC no formato RFC3339.	2024-03-10T09:56:17Z

Exemplos

Resposta de sucesso

JSON formato

{
  "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"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.