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 parâmetros de banco de dados para sincronização de dados do StarRocks
Atualizado em 2025-05-23 GMT+08:00

Consulta de configurações de parâmetros de banco de dados para sincronização de dados do StarRocks

Função

Essa API é usada para consultar configurações de parâmetros do banco de dados para sincronização de dados do StarRocks. Antes de chamar essa API:

URI

GET /v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/database-parameters

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.

Parâmetros de solicitação

Tabela 2 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 3 Parâmetros do corpo de resposta

Parâmetro

Tipo

Descrição

db_parameters

Array of DbParameter objects

Informações de parâmetro do banco de dados.

Tabela 4 DbParameter

Parâmetro

Tipo

Descrição

param_name

String

Nome do parâmetro.

data_type

String

Tipo de parâmetro.

default_value

String

Valor padrão do parâmetro.

value_range

String

Intervalo de valores do parâmetro.

description

String

Descrição do parâmetro.

Código de status: 400

Tabela 5 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 6 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 de configurações de parâmetros de banco de dados para sincronização de dados de uma instância do StarRocks com ID de instância especificado

GET https://{localhost}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/database-parameters

Exemplo de resposta

Código de status: 200

Bem-sucedido.

{
  "db_parameters" : [ {
    "param_name" : "enable_chunk_level_dump",
    "data_type" : "String",
    "default_value" : "false",
    "value_range" : "true|false",
    "description" : "Whether to enable shard replication."
  }, {
    "param_name" : "snapshot_with_lock",
    "data_type" : "String",
    "default_value" : "true",
    "value_range" : "true|false",
    "description" : "Whether a lock is added when a full snapshot is obtained. The default value is true."
  }, {
    "param_name" : "sync_commit_interval_ms",
    "data_type" : "Integer",
    "default_value" : "5000",
    "value_range" : "1000-60000",
    "description" : "Timeout interval for batch commit. Data is committed when the timeout interval is reached or the buffer is full."
  }, {
    "param_name" : "max_sync_commit_rows",
    "data_type" : "Integer",
    "default_value" : "500000",
    "value_range" : "500000-2000000",
    "description" : "Maximum number of rows allowed for each commit."
  }, {
    "param_name" : "max_sync_commit_bytes",
    "data_type" : "Integer",
    "default_value" : "268435456",
    "value_range" : "10485760-1610612736",
    "description" : "Maximum number of bytes allowed for each commit."
  }, {
    "param_name" : "max_full_sync_task_threads_num",
    "data_type" : "Integer",
    "default_value" : "1",
    "value_range" : "1-2",
    "description" : "Maximum threads allowed for full synchronization."
  }, {
    "param_name" : "max_rows_per_chunk",
    "data_type" : "Integer",
    "default_value" : "0",
    "value_range" : "0-1000000",
    "description" : "Maximum number of rows per shard."
  }, {
    "param_name" : "max_bytes_per_chunk",
    "data_type" : "Integer",
    "default_value" : "268435456",
    "value_range" : "33554432-1073741824",
    "description" : "Maximum number of bytes per shard."
  }, {
    "param_name" : "binlog_expire_logs_seconds",
    "data_type" : "Integer",
    "default_value" : "86400",
    "value_range" : "0-604800",
    "description" : "Binlog retention period, which must be no greater than that of TaurusDB. The value 0 indicates that the retention period is not limited."
  } ]
}

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.