Verificação das configurações do banco de dados para sincronização de dados
Função
Essa API é usada para verificar as configurações do banco de dados para sincronização de dados. Antes de chamar essa API:
- Saiba como autorizá-la e autenticá-la.
- Obtenha a região e o ponto de extremidade necessários.
URI
POST /v3/{project_id}/instances/{instance_id}/clickhouse/replication/database-check
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. |
Parâmetros 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:
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
source_instance_id |
Sim |
String |
ID da instância de origem, que é compatível com o formato UUID. |
source_node_id |
Não |
String |
ID do nó de origem (ID da réplica de leitura). Se esse parâmetro for deixado em branco, o ID do nó primário será usado. |
source_database_name |
Sim |
String |
Nome do banco de dados de origem. |
db_configs |
Sim |
Array of ChDatabaseConfigsInfo objects |
Configurações de banco de dados. |
table_repl_config |
Sim |
Configurações de tabela. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
param_name |
Sim |
String |
Nome do parâmetro de configuração de sincronização do banco de dados. Para obter esse valor, consulte Consulta de configurações de parâmetros de banco de dados para sincronização de dados. |
value |
Sim |
String |
Valor do parâmetro de configuração de sincronização do banco de dados. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
repl_type |
Sim |
String |
Tipo de sincronização de tabela. Valores:
|
tables |
Sim |
Array of strings |
Tabelas listadas na lista de permissões ou na lista de bloqueios. |
Parâmetros de resposta
Código de status: 200
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. |
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:
|
Código de status: 400
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Mensagem de erro. |
Código de status: 500
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Mensagem de erro. |
Exemplo de solicitação
Verificação das configurações do banco de dados para sincronização de dados
POST https://{localhost}/v3/23a50154cf494ec9ad6883979a12db0a/instances/54e42160670e48e789af7075e1efea1fin16/clickhouse/replication/database-check { "source_database_name" : "blackwhite_0018_61474479", "db_configs" : [ { "param_name" : "default_isolation_level", "value" : "QUERY_SNAPSHOT" } ], "table_replconfig" : { "repl_type" : "black_list", "tables" : [ ] }, "source_instance_id" : "77aa4096cb824a61b93dab5ca00ecc8fin07", "source_node_id" : "57bfeacf6e8d4eb685ea907372374b35no07" }
Exemplo de resposta
Código de status: 200
Bem-sucedido.
{ "database_name" : "blackwhite_0017_22525694", "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" } ] }
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.