DescribeDBClusterNodeInfos - ApsaraDB for ClickHouse: Central de Documentação do Alibaba Cloud

Consulta as informações dos nós de uma instância ClickHouse compatível com a comunidade.

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

clickhouse:DescribeDBClusterNodeInfos

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Não	O ID da região.	cn-hangzhou
DBClusterId	string	Sim	O ID do cluster.	cc-bp108z124a8o7****
PageSize	integer	Não	O número de entradas por página. Valores válidos: 30 (padrão) 50 100	30
PageNumber	integer	Não	O número da página.	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	746CD303-0B82-5E8D-886D-93A9FAF3A876
NodeInfos	array<object>	As informações sobre os nós do ClickHouse.
	object	As informações do nó.
ShardId	string	O ID do shard.	2
ReplicaId	string	O ID do nó.	1
NodeName	string	O nome do nó.	ck-bp108z124a8****
NodeIp	string	O endereço IP do nó.	172.168.0.1
FailoverTesting	boolean	Indica se um teste de recuperação de desastres está em andamento.	true
ZkNodeInfos	array<object>	As informações sobre os nós do ZooKeeper.
	object
ReplicaId	string	O ID do nó do ZooKeeper.	1
NodeName	string	O nome do nó.	ck-bp108z124a8****
FailoverTesting	boolean	Indica se um teste de recuperação de desastres está em andamento.	true
PageNumber	integer	O número da página.	1
PageSize	integer	O número de entradas por página. Valores válidos: 30 (padrão) 50 100	30
TotalNodeCount	integer	O número total de nós.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "746CD303-0B82-5E8D-886D-93A9FAF3A876",
  "NodeInfos": [
    {
      "ShardId": "2",
      "ReplicaId": "1",
      "NodeName": "ck-bp108z124a8****",
      "NodeIp": "172.168.0.1",
      "FailoverTesting": true
    }
  ],
  "ZkNodeInfos": [
    {
      "ReplicaId": "1",
      "NodeName": "ck-bp108z124a8****\n",
      "FailoverTesting": true
    }
  ],
  "PageNumber": 1,
  "PageSize": 30,
  "TotalNodeCount": 1
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
500	InternalError	An error occurred while processing your request.	An error occurred while processing your request.
503	ServiceUnavailable	An error occurred while processing your request.	An error occurred while processing your request.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.