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

Descrição da operação

O período de validade padrão de um certificado emitido para um arquivo kubeconfig é de três anos. Dentro de 180 dias antes do vencimento, você pode obter um arquivo kubeconfig atualizado com certificados rotacionados por meio do console do Container Service for Kubernetes ou chamando a operação de API para obter o kubeconfig do cluster. O novo certificado do kubeconfig permanece válido por três anos. As credenciais antigas do kubeconfig permanecem válidas até que o certificado expire. Obtenha as credenciais rotacionadas tempestivamente com base na data de expiração do kubeconfig exibida no console ou retornada pela operação de API.
Gerencie adequadamente as credenciais do kubeconfig para o gerenciamento do cluster e revogue-as imediatamente quando não forem mais necessárias para evitar riscos de segurança, como vazamentos de dados causados pela exposição do 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 obter a configuração de conexão de rede interna. Valores válidos: true: obtém apenas as credenciais de conexão de rede interna. false: obtém apenas as credenciais de conexão de rede pública. Valor padrão: false.	false
TemporaryDurationMinutes	integer	Não	O período de validade do arquivo kubeconfig temporário, em minutos. Valores válidos: 15 a 4320. Nota Se você não especificar este parâmetro, o sistema determinará automaticamente um período de validade mais longo. Você pode determinar a data de expiração específica com base no valor do campo expiration na resposta.	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	A data de expiração do arquivo kubeconfig. O horário é exibido em UTC e segue o padrão RFC 3339.	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.