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

Se você precisar visualizar o status do controle de acesso do cluster atual, pode invocar a API ListClusterKubeconfigStates para obter a lista e o status das configurações KubeConfig que foram emitidas para os usuários do cluster atual.

Descrição da operação

Nota

A invocação desta API requer as permissões ram:ListUsers e ram:ListRoles.
A invocação desta API requer permissões para gerenciar o Container Service (CS) (AliyunCSFullAccess).

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:ListClusterKubeconfigStates

none

*Cluster

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

Nenhuma

Sintaxe da solicitação

GET /clusters/{ClusterId}/kubeconfig/states HTTP/1.1

Parâmetros de caminho

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

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
pageNumber	integer	Não	O número da página. Valores válidos: ≥ 1. Valor padrão: 1.	1
pageSize	integer	Não	O número de entradas por página. Valores válidos: 10 a 50. Valor padrão: 10	10
cloudServiceKubeConfig	boolean	Não	Se deve consultar a lista de KubeConfig de funções de serviço para produtos de nuvem dentro do cluster. true: Consulta a lista de KubeConfig de funções de serviço para produtos de nuvem dentro do cluster. false: Consulta a lista de KubeConfig de usuários ou funções do Resource Access Management (RAM) dentro do cluster. Valores válidos: true : true. false : false.	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O corpo da resposta.
states	array<object>	A lista de status dos arquivos kubeconfig associados ao cluster.
	array<object>
account_id	string	O ID de uma conta Alibaba Cloud, usuário RAM ou função RAM.	22855*****************
account_name	string	O nome de logon ou nome da função do usuário RAM.	tom
account_display_name	string	O nome de exibição ou nome da função do usuário RAM.	tom
account_type	string	O tipo da conta. RootAccount: Conta Alibaba Cloud. RamUser: Usuário RAM. RamRole: Função RAM.	RamUser
account_state	string	O status da conta. Active: A conta está ativa. InActive: A conta está bloqueada. Deleted: A conta foi excluída.	Active
cert_expire_time	string	O horário de expiração do certificado de cliente do arquivo kubeconfig.	2027-07-15T01:32:20Z
cert_state	string	O status do certificado de cliente do arquivo kubeconfig. Unexpired: O certificado não expirou. Expired: O certificado expirou. Unknown: O status do certificado é desconhecido.	Expired
revokable	boolean	Indica se o certificado de cliente do arquivo kubeconfig pode ser revogado.	true
cloud_service_name	string	O nome do serviço de nuvem.	cs/ecs/sls
cloud_service_roles	array<object>	Lista de funções de cluster associadas às funções de serviço de produtos de nuvem do cluster.
	object	Informações sobre a função de cluster associada à função de serviço de produto de nuvem do cluster.
type	string	O tipo da função de cluster associada à função de serviço em nuvem. Valores válidos: Role : Role. ClusterRole : ClusterRole.	ClusterRole
role_name	string	O nome da função de cluster associada à função de serviço em nuvem.	cluster-admin
role_namespace	string	O namespace da função de cluster associada à função de serviço em nuvem.	kube-system
is_default_template	boolean	Indica se o conteúdo corresponde ao modelo padrão de função de cluster. Valores válidos: true: o conteúdo corresponde ao modelo padrão. false: o conteúdo não corresponde ao modelo padrão.
page	object	As informações de paginação.
page_number	integer	O número da página.	1
page_size	integer	O número de entradas por página.	10
total_count	integer	O número total de entradas retornadas.	5

Exemplos

Resposta de sucesso

JSON formato

{
  "states": [
    {
      "account_id": "22855*****************",
      "account_name": "tom",
      "account_display_name": "tom",
      "account_type": "RamUser",
      "account_state": "Active",
      "cert_expire_time": "2027-07-15T01:32:20Z",
      "cert_state": "Expired",
      "revokable": true,
      "cloud_service_name": "cs/ecs/sls",
      "cloud_service_roles": [
        {
          "type": "ClusterRole",
          "role_name": "cluster-admin",
          "role_namespace": "kube-system",
          "is_default_template": false
        }
      ]
    }
  ],
  "page": {
    "page_number": 1,
    "page_size": 10,
    "total_count": 5
  }
}

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.