DescribeClusterBasicInfo - Security Center: Central de Documentação do Alibaba Cloud

Consulta as informações do cluster por ID do cluster.

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

yundun-sas:DescribeClusterBasicInfo

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ClusterId	string	Sim	O ID do cluster que você deseja consultar. Nota Você pode chamar a operação DescribeGroupedContainerInstances para obter este parâmetro.	c870ec78ecbcb41d2a35c679823ef****
Type	string	Sim	O tipo de configuração. Valores válidos: containerNetwork: switch de topologia de rede de contêineres interceptionSwitch: switch de microssegmentação de cluster.	containerNetwork
TargetType	string	Sim	A dimensão da operação da configuração do switch de destino. Valores válidos: Cluster: ID do cluster.	Cluster

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação. É um identificador exclusivo gerado pelo Alibaba Cloud para a solicitação e pode ser usado para solucionar problemas.	24A20733-10A0-4AF6-BE6B-E3322413BB68
ClusterInfo	object	Os detalhes do cluster.
InstanceCount	integer	O número de instâncias no cluster.	10
ClusterType	string	O tipo de cluster. Valores válidos: ManagedKubernetes: Kubernetes gerenciado NotManagedKubernetes: Kubernetes não gerenciado PrivateKubernetes: cluster privado kubernetes: Kubernetes dedicado ask: ASK dedicado.	kubernetes
State	string	O status de disponibilidade. Valores válidos: unavailable: Não disponível. Available: Disponível. Creating: Sendo criado. CreateFailed: Falha na criação.	Available
CreateTime	integer	O timestamp em que o cluster foi criado. Unidade: milissegundos.	1662038134000
ClusterName	string	O nome do cluster.	testackpro
CurrentVersion	string	As informações de versão do cluster.	1.22.10-aliyun.1
TargetResult	boolean	O status do switch do cluster. true: ativado false: desativado.	true
RegionId	string	O ID da região do cluster.	cn-hangzhou
ClusterId	string	O ID do cluster.	c870ec78ecbcb41d2a35c679823ef****

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "24A20733-10A0-4AF6-BE6B-E3322413BB68",
  "ClusterInfo": {
    "InstanceCount": 10,
    "ClusterType": "kubernetes",
    "State": "Available",
    "CreateTime": 1662038134000,
    "ClusterName": "testackpro",
    "CurrentVersion": "1.22.10-aliyun.1",
    "TargetResult": true,
    "RegionId": "cn-hangzhou",
    "ClusterId": "c870ec78ecbcb41d2a35c679823ef****\n"
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
500	ServerError	ServerError
403	NoPermission	caller has no permission

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.