Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Central de ajuda/TaurusDB/Referência de API/APIs (recomendadas)/HTAP (edição leve)/Consulta de configurações de sincronização de dados
Atualizado em 2025-05-23 GMT+08:00
Ver PDF
Compartilhar

Consulta de configurações de sincronização de dados

Função

Essa API é usada para consultar a configuração de sincronização de dados. Antes de chamar essa API:

URI

GET /v3/{project_id}/instances/{instance_id}/clickhouse/replication/config

Tabela 1 Parâmetros de URI

Parâmetro

Obrigatório

Tipo

Descrição

project_id

Sim

String

ID do projeto de um locatário numa região.

Para obter esse valor, consulte Obtenção de um ID de projeto.

instance_id

Sim

String

ID da instância do ClickHouse, que é compatível com o formato UUID.

Tabela 2 Parâmetros de consulta

Parâmetro

Obrigatório

Tipo

Descrição

database_name

Sim

String

Nome do banco de dados.

Parâmetros de solicitação

Tabela 3 Parâmetros de cabeçalho de solicitação

Parâmetro

Obrigatório

Tipo

Descrição

X-Auth-Token

Sim

String

Token do usuário.

Para obter esse valor, chame a API do IAM para obter um token de usuário.

O valor de X-Subject-Token no cabeçalho da resposta é o valor do token.

X-Language

Não

String

Tipo de linguagem da solicitação. O valor padrão é en-us.

Valores:

  • en-us
  • zh-cn

Parâmetros de resposta

Código de status: 200

Tabela 4 Parâmetros do corpo de resposta

Parâmetro

Tipo

Descrição

source_instance_id

String

ID da instância de origem.

source_node_id

String

ID do nó da instância de origem.

database_info

ChDatabaseConfigResponse object

Informações de configuração do banco de dados.

table_infos

Array of ChDatabaseTableConfigCheckResult objects

Configurações de tabela.

table_repl_config

ChDatabaseTableReplConfigInfo object

Configurações de sincronização de tabela.

is_tables_change

Boolean

Se há alguma alteração no escopo de sincronização (tabelas a serem sincronizadas).

new_table_repl_config

ChDatabaseTableReplConfigInfo object

Configurações de sincronização de tabela atualizadas.

last_error_of_alter_table

String

Exceção sobre a última operação ALTER TABLE.

Tabela 5 ChDatabaseConfigResponse

Parâmetro

Tipo

Descrição

database_name

String

Nome do banco de dados de origem.

db_config_check_results

Array of ChDatabaseConfigCheckResult objects

Resultado de verificação das configurações do banco de dados de origem.

Tabela 6 ChDatabaseConfigCheckResult

Parâmetro

Tipo

Descrição

param_name

String

Nome do parâmetro de configuração de sincronização do banco de dados.

value

String

Valor do parâmetro de configuração de sincronização do banco de dados.

check_result

String

Resultado de verificação. Valores:

  • success
  • fail
Tabela 7 ChDatabaseTableConfigCheckResult

Parâmetro

Tipo

Descrição

table_name

String

Nome da tabela.

table_config

String

Item de configuração da tabela.

As seguintes operações de coluna são permitidas: PARTITION BY, COLUMNS, ORDER BY, SAMPLE BY, PRIMARY KEY e TTL.

check_result

String

Resultado de verificação.

Tabela 8 ChDatabaseTableReplConfigInfo

Parâmetro

Tipo

Descrição

repl_type

String

Tipo de sincronização de tabela. Valores:

  • white_list: lista de permissões. Nesse caso, as tabelas não podem ser deixadas em branco.
  • black_list: lista de bloqueios. Se as tabelas forem deixadas em branco, todas as tabelas serão selecionadas.

tables

Array of strings

Tabelas listadas na lista de permissões ou na lista de bloqueios.

Código de status: 400

Tabela 9 Parâmetros do corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Código de status: 500

Tabela 10 Parâmetros do corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Exemplo de solicitação

Consulta das configurações de sincronização de dados do banco de dados db_test

GET https://{localhost}/v3/23a50154cf494ec9ad6883979a12db0a/instances/54e42160670e48e789af7075e1efea1fin16/clickhouse/replication/config?database_name=db_test

Exemplo de resposta

Código de status: 200

Bem-sucedido.

{
  "source_instance_id" : "77aa4096cb824a61b93dab5ca00ecc8fin07",
  "source_node_id" : "57bfeacf6e8d4eb685ea907372374b35no07",
  "database_info" : {
    "database_name" : "blackwhite_0018_61474479",
    "db_config_check_results" : [ {
      "param_name" : "default_isolation_level",
      "value" : "QUERY_SNAPSHOT",
      "check_result" : "success"
    }, {
      "param_name" : "enable_snapshots",
      "value" : "true",
      "check_result" : "success"
    }, {
      "param_name" : "enable_chunk_level",
      "value" : "true",
      "check_result" : "success"
    }, {
      "param_name" : "max_sync_threads",
      "value" : "1",
      "check_result" : "success"
    }, {
      "param_name" : "treat_numeric_string_as_integer",
      "value" : "false",
      "check_result" : "success"
    }, {
      "param_name" : "min_binlog_expire_logs_seconds",
      "value" : "86400",
      "check_result" : "success"
    }, {
      "param_name" : "max_rows_in_buffer",
      "value" : "2000000",
      "check_result" : "success"
    }, {
      "param_name" : "max_rows_in_buffers",
      "value" : "6000000",
      "check_result" : "success"
    }, {
      "param_name" : "max_bytes_in_buffer",
      "value" : "200000000",
      "check_result" : "success"
    }, {
      "param_name" : "max_bytes_in_buffers",
      "value" : "600000000",
      "check_result" : "success"
    }, {
      "param_name" : "max_flush_data_time",
      "value" : "5000",
      "check_result" : "success"
    } ]
  },
  "table_infos" : [ ],
  "table_repl_config" : {
    "repl_type" : "black_list",
    "tables" : [ ]
  },
  "is_tables_change" : false,
  "new_table_repl_config" : {
    "repl_type" : null,
    "tables" : null
  },
  "last_error_of_alter_table" : null
}

Código de status

Código de status

Descrição

200

Bem-sucedido.

400

Erro do cliente.

500

Erro no servidor.

Código de erro

Para obter detalhes, consulte Códigos de erro.

Tópico principal:HTAP (edição leve)