Verificação das configurações do banco de dados para sincronização de dados HTAP
Função
Essa API é usada para verificar as configurações do banco de dados para sincronização de dados HTAP. 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}/starrocks/databases/replication/database-config-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 StarRocks, 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 |
Sim |
String |
Tipo de linguagem da solicitação. O valor padrão é en-us. Valores:
|
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
source_instance_id |
Não |
String |
ID da instância do TaurusDB. |
|
source_node_id |
Não |
String |
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 |
Não |
String |
Nome do banco de dados TaurusDB. O valor pode conter de 3 a 1024 caracteres. Somente letras maiúsculas, letras minúsculas, dígitos e sublinhados (_) são permitidos. |
|
target_database_name |
Não |
String |
Nome do banco de dados de destino. O valor pode conter de 3 a 128 caracteres. Somente letras maiúsculas, letras minúsculas, dígitos e sublinhados (_) são permitidos. |
|
task_name |
Não |
String |
Nome da tarefa de sincronização. O valor pode conter de 3 a 128 caracteres. Somente letras maiúsculas, letras minúsculas, dígitos e sublinhados (_) são permitidos. |
|
db_configs |
Não |
Array of DbConfig objects |
Configurações de banco de dados. |
|
table_repl_config |
Não |
TableReplConfig object |
Configurações de tabela. |
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
param_name |
Não |
String |
Nome do parâmetro. |
|
value |
Não |
String |
Valor do parâmetro. |
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
repl_type |
Não |
String |
Tipo de sincronização de tabela.
|
|
repl_scope |
Não |
String |
Escopo de sincronização da tabela.
|
|
tables |
Não |
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 |
|---|---|---|
|
source_database_name |
String |
Nome do banco de dados de destino. O valor pode conter de 3 a 128 caracteres. Somente letras maiúsculas, letras minúsculas, dígitos e sublinhados (_) são permitidos. |
|
source_db_config_check_results |
Array of DbConfigCheckResult objects |
Verifique os resultados das configurações do banco de dados do TaurusDB. |
|
target_database_name |
String |
Nome do banco de dados de destino. O valor pode conter de 3 a 128 caracteres. Somente letras maiúsculas, letras minúsculas, dígitos e sublinhados (_) são permitidos. |
|
target_db_config_check_results |
Array of DbConfigCheckResult objects |
Verifique o resultado das configurações do banco de dados de destino. |
|
task_name |
String |
Nome da tarefa de sincronização. O valor pode conter de 3 a 128 caracteres. Somente letras maiúsculas, letras minúsculas, dígitos e sublinhados (_) são permitidos. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
param_name |
String |
Nome do parâmetro. O nome pode conter de 3 a 128 caracteres. |
|
value |
String |
Valor do parâmetro. O valor pode conter de 1 a 64 caracteres. |
|
check_result |
String |
Resultado da 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
POST https://{localhost}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/database-config-check
{
"source_database_name" : "source_database_name",
"target_database_name" : "target_database_name",
"db_configs" : [ {
"param_name" : "enable_chunk_level_dump",
"value" : "false"
}, {
"param_name" : "snapshot_with_lock",
"value" : "true"
}, {
"param_name" : "sync_commit_interval_ms",
"value" : "5000"
}, {
"param_name" : "max_sync_commit_rows",
"value" : "500000"
}, {
"param_name" : "max_sync_commit_bytes",
"value" : "268435456"
}, {
"param_name" : "max_full_sync_task_threads_num",
"value" : "1"
}, {
"param_name" : "max_rows_per_chunk",
"value" : "0"
}, {
"param_name" : "max_bytes_per_chunk",
"value" : "268435456"
}, {
"param_name" : "binlog_expire_logs_seconds",
"value" : "0"
} ],
"table_replconfig" : {
"repl_type" : "include_tables",
"repl_scope" : "all",
"tables" : [ ]
},
"source_instance_id" : "source_instance_id",
"source_node_id" : "source_node_id"
}
Exemplo de resposta
Código de status: 200
Bem-sucedido.
{
"source_database_name" : "source_database_name",
"target_database_name" : "",
"source_db_config_check_results" : [ {
"param_name" : "enable_chunk_level_dump",
"value" : "false",
"check_result" : "success"
}, {
"param_name" : "snapshot_with_lock",
"value" : "true",
"check_result" : "success"
} ],
"target_db_config_check_results" : [ ]
}
Código de status: 400
Erro do cliente.
{
"error_code" : "DBS.200022",
"error_msg" : "Instance not found."
}
Código de status
Para mais detalhes, consulte Códigos de status.
Código de erro
Para mais detalhes, consulte Códigos de erro.
