DescribeContainerCluster - Cloud Backup: Central de Documentação do Alibaba Cloud

Consulta um ou mais clusters de contêineres que atendem às condições especificadas.

Descrição da operação

Suportado apenas para integração com o Container Service for Kubernetes (ACK).

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

hbr:DescribeContainerCluster

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PageNumber	integer	Não	O número da página a ser retornada. As páginas começam a partir da página 1. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valores válidos: 1 a 99. Valor padrão: 10.	10
ClusterId	string	Não	O ID do cluster.	cc-000**************hg9
Identifier	string	Não	O identificador do cluster de contêineres. Para um cluster do Container Service for Kubernetes (ACK), especifique o ID do cluster.	cca***************************87a

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	CC94B755-C3C2-5B9D-BD77-E0FE819A4DB2
Success	boolean	Indica se a chamada foi bem-sucedida. Valores válidos: true: a chamada foi bem-sucedida. false: a chamada falhou.	true
Code	string	O código de status HTTP. O código de status 200 indica que a chamada foi bem-sucedida.	200
Message	string	A mensagem retornada. Se a chamada for bem-sucedida, "successful" será retornado. Se a chamada falhar, uma mensagem de erro será retornada.	successful
PageSize	integer	O número de entradas retornadas em cada página. Valores válidos: 1 a 99. Valor padrão: 10.	100
PageNumber	integer	O número da página retornada. As páginas começam a partir da página 1. Valor padrão: 1.	1
TotalCount	integer	O número total de entradas retornadas.	8
Clusters	array<object>	As informações dos clusters.
	object	As informações dos clusters.
Token	string	O token usado para registrar o cliente do Hybrid Backup Recovery (HBR) no cluster.	eyJhY2Nvd******A/VnZpgXQC5A==
Description	string	A descrição.	description ack pv backup
ClusterType	string	O tipo do cluster. Valor válido: ACK, que indica clusters ACK.	ACK
Identifier	string	O identificador do cluster.	c5bbd0931a30947f4ab85efd19380a72d
NetworkType	string	O tipo de rede do cluster. Valores válidos: CLASSIC: rede clássica VPC: virtual private cloud (VPC)	VPC
Name	string	O nome do cluster.	ack_pv_backup_location
AgentStatus	string	O status do cliente. Valores válidos: MISS: o cliente está desconectado. UNKNOWN: o cliente está em um estado desconhecido. READY: o cliente está pronto.	READY
ClusterId	string	O ID do cluster.	cl-0006gwppd0jtttpmb0ri

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "CC94B755-C3C2-5B9D-BD77-E0FE819A4DB2",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageSize": 100,
  "PageNumber": 1,
  "TotalCount": 8,
  "Clusters": [
    {
      "Token": "eyJhY2Nvd******A/VnZpgXQC5A==",
      "Description": "description ack pv backup",
      "ClusterType": "ACK",
      "Identifier": "c5bbd0931a30947f4ab85efd19380a72d",
      "NetworkType": "VPC",
      "Name": "ack_pv_backup_location",
      "AgentStatus": "READY",
      "ClusterId": "cl-0006gwppd0jtttpmb0ri"
    }
  ]
}

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.