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 padrão)/Consulta de configurações de uma tarefa de sincronização de dados do StarRocks
Atualizado em 2025-05-23 GMT+08:00
Ver PDF
Compartilhar

Consulta de configurações de uma tarefa de sincronização de dados do StarRocks

Função

Essa API é usada para consultar configurações de uma tarefa de sincronização de dados do StarRocks. Antes de chamar essa API:

URI

GET /v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/configuration

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 StarRocks, que é compatível com o formato UUID.

Tabela 2 Parâmetros de consulta

Parâmetro

Obrigatório

Tipo

Descrição

task_name

Sim

String

Nome da tarefa de sincronização de dados. O valor pode conter de 3 a 128 caracteres. Somente letras maiúsculas, letras minúsculas, dígitos e sublinhados (_) são permitidos.

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

Sim

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 do TaurusDB.

source_node_id

String

ID do nó do TaurusDB.

database_info

DataBaseInfo object

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

table_infos

Array of TableConfigCheckResult objects

Configurações de tabela.

table_repl_config

TableReplConfig object

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

new_table_repl_config

TableReplConfig object

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

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.

is_tables_change

Boolean

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

last_error_of_alter_table

String

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

Tabela 5 DataBaseInfo

Parâmetro

Tipo

Descrição

database_name

String

Nome do banco de dados.

db_config_check_results

Array of DbConfigCheckResult objects

Resultado da verificação da configuração do banco de dados.

Tabela 6 DbConfigCheckResult

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 de verificação.

Valores:

  • success
  • fail
Tabela 7 TableConfigCheckResult

Parâmetro

Tipo

Descrição

table_name

String

Nome da tabela.

  • Comprimento mínimo: 2 caracteres
  • Comprimento máximo: 1024 caracteres

table_config

String

Item de configuração da tabela.

  • Comprimento mínimo: 2 caracteres
  • Comprimento máximo: 1024 caracteres

check_result

String

Resultado de verificação. Valor: success ou fail

  • Comprimento mínimo: 2 caracteres
  • Comprimento máximo: 10 caracteres
Tabela 8 TableReplConfig

Parâmetro

Tipo

Descrição

repl_type

String

Tipo de sincronização de tabela.

  • include_tables: lista de permissões
  • exclude_tables: lista de bloqueios

repl_scope

String

Escopo de sincronização da tabela.

  • all: todas as tabelas
  • part: algumas tabelas

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 da tarefa de sincronização de dados taskName

GET https://{localhost}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/configuration?task_name=taskName

Exemplo de resposta

Código de status: 200

Bem-sucedido.

{
  "source_instance_id" : "source_instance_id",
  "target_database_name" : "target_database_name",
  "source_node_id" : "source_node_id",
  "database_info" : {
    "database_name" : "database_name",
    "db_config_check_results" : [ {
      "param_name" : "default_isolation_level",
      "value" : "QUERY_SNAPSHOT",
      "check_result" : "success"
    }, {
      "param_name" : "enable_snapshots",
      "value" : "true",
      "check_result" : "failed"
    } ]
  },
  "table_info" : [ ],
  "table_repl_config" : {
    "repl_type" : "exclude_tables",
    "repl_scope" : "all",
    "tables" : [ ]
  },
  "new_table_repl_config" : { },
  "is_tables_change" : false,
  "last_error_of_alter_table" : ""
}

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.

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