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

Consulta informações sobre bancos de dados sincronizados.

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

get

*DBCluster

acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DbClusterId	string	Sim	O ID do cluster do ApsaraDB for ClickHouse.	cc-bp1ab22b80814****
PageSize	integer	Não	O número de registros a serem retornados em cada página.	20
PageNumber	integer	Não	O número da página atual.	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	7655F5F9-1313-5ABA-8516-F6EB79605A5F
SynDbs	array<object>	Os dados sincronizados.
	object	Os objetos sincronizados para o ClickHouse.
RdsId	string	O ID da instância do ApsaraDB RDS for MySQL.	rm-wz9d11qg1j0h4****
SynDb	string	O banco de dados na instância do ApsaraDB RDS for MySQL.	database
SynStatus	boolean	Indica se a sincronização foi bem-sucedida. Valores válidos:\n- true: A sincronização foi bem-sucedida.\n- false: A sincronização falhou.	true
ErrorMsg	string	Este parâmetro não é retornado se SynStatus for true.\n- Se SynStatus for false, este parâmetro indica o motivo da falha de sincronização.	ClickHouse exception, code: 49, host: 100.100.118.132, port: 49670; Code: 49, e.displayText() = DB::Exception: Logical error: there is no global context (version 20.8.17.25)n
RdsUserName	string	A conta do banco de dados da instância do ApsaraDB RDS for MySQL.	test
RdsVpcUrl	string	O endpoint interno da instância do ApsaraDB RDS for MySQL.	rm-bp16t9h3999xb0a711****.mysql.rds.aliyuncs.com:3306
TotalCount	integer	O número total de registros.	0
PageSize	integer	O número de registros em cada página.	20
PageNumber	integer	O número da página atual.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "7655F5F9-1313-5ABA-8516-F6EB79605A5F",
  "SynDbs": [
    {
      "RdsId": "rm-wz9d11qg1j0h4****",
      "SynDb": "database",
      "SynStatus": true,
      "ErrorMsg": "ClickHouse exception, code: 49, host: 100.100.118.132, port: 49670; Code: 49, e.displayText() = DB::Exception: Logical error: there is no global context (version 20.8.17.25)n",
      "RdsUserName": "test",
      "RdsVpcUrl": "rm-bp16t9h3999xb0a711****.mysql.rds.aliyuncs.com:3306"
    }
  ],
  "TotalCount": 0,
  "PageSize": 20,
  "PageNumber": 1
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The DBClusterId provided does not exist in our records.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.