Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.
Centro de ayuda/ TaurusDB/ Referencia de la API/ Las API (recomendadas)/ HTAP (Edición estándar)/ Comprobación de configuraciones de base de datos para la sincronización de datos htap
Actualización más reciente 2025-03-21 GMT+08:00

Comprobación de configuraciones de base de datos para la sincronización de datos htap

Función

Esta API se utiliza para comprobar las configuraciones de la base de datos para la sincronización de datos de HTAP. Antes de invocar a esta API:

URI

POST /v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/database-config-check

Tabla 1 Parámetros de URI

Parámetro

Obligatorio

Tipo

Descripción

project_id

String

ID de proyecto de un tenant en una región.

Para obtener este valor, consulte Obtención de un ID de proyecto.

instance_id

String

ID de instancia de StarRocks, que es compatible con el formato UUID.

Parámetros de solicitud

Tabla 2 Parámetros de encabezado de solicitud

Parámetro

Obligatorio

Tipo

Descripción

X-Auth-Token

String

Token de usuario.

Para obtener este valor, invoque a la API de IAM para obtener un token de usuario.

El valor de X-Subject-Token en el encabezado de respuesta es el valor del token.

X-Language

String

Tipo de idioma de solicitud. El valor predeterminado es en-us. Valores:

  • en-us
  • zh-cn
Tabla 3 Parámetros del cuerpo de solicitud

Parámetro

Obligatorio

Tipo

Descripción

source_instance_id

No

String

ID de instancia de TaurusDB.

source_node_id

No

String

ID de réplica de lectura. Si este parámetro se deja en blanco, se utilizará el ID del nodo primario.

source_database_name

No

String

Nombre de la base de datos de TaurusDB. El valor puede contener entre 3 y 1024 caracteres. Solo se permiten mayúsculas, minúsculas, dígitos y guiones bajos (_).

target_database_name

No

String

Nombre de la base de datos de destino. El valor puede contener de 3 a 128 caracteres. Solo se permiten mayúsculas, minúsculas, dígitos y guiones bajos (_).

task_name

No

String

Nombre de la tarea de sincronización. El valor puede contener de 3 a 128 caracteres. Solo se permiten mayúsculas, minúsculas, dígitos y guiones bajos (_).

db_configs

No

Array of DbConfig objects

Configuraciones de bases de datos.

table_repl_config

No

TableReplConfig object

Configuraciones de tablas.

Tabla 4 DbConfig

Parámetro

Obligatorio

Tipo

Descripción

param_name

No

String

Nombre del parámetro.

value

No

String

Valor del parámetro.

Tabla 5 TableReplConfig

Parámetro

Obligatorio

Tipo

Descripción

repl_type

No

String

Tipo de sincronización de tabla.

  • include_tablas: lista blanca
  • exclude_tablas: lista negra

repl_scope

No

String

Ámbito de sincronización de tablas.

  • all: todas las tablas
  • part: algunas tablas

tables

No

Array of strings

Tablas incluidas en la lista blanca o en la lista negra.

Parámetros de respuesta

Código de estado: 200

Tabla 6 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

source_database_name

String

Nombre de la base de datos de destino. El valor puede contener de 3 a 128 caracteres. Solo se permiten mayúsculas, minúsculas, dígitos y guiones bajos (_).

source_db_config_check_results

Array of DbConfigCheckResult objects

Los resultados de comprobación de las configuraciones de la base de datos de TaurusDB.

target_database_name

String

Nombre de la base de datos de destino. El valor puede contener de 3 a 128 caracteres. Solo se permiten mayúsculas, minúsculas, dígitos y guiones bajos (_).

target_db_config_check_results

Array of DbConfigCheckResult objects

Los resultados de comprobación de las configuraciones de la base de datos destino.

task_name

String

Nombre de la tarea de sincronización. El valor puede contener de 3 a 128 caracteres. Solo se permiten mayúsculas, minúsculas, dígitos y guiones bajos (_).

Tabla 7 DbConfigCheckResult

Parámetro

Tipo

Descripción

param_name

String

Nombre del parámetro. El nombre puede contener de 3 a 128 caracteres.

value

String

Valor del parámetro. El valor puede contener de 1 a 64 caracteres.

check_result

String

Resultado de la comprobación.

Valores:

  • success
  • fail

Código de estado: 400

Tabla 8 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 500

Tabla 9 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Ejemplo de la solicitud

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"
}

Ejemplo de la respuesta

Código de estado: 200

Operación exitosa.

{
  "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 estado: 400

Error de cliente.

{
  "error_code" : "DBS.200022",
  "error_msg" : "Instance not found."
}

Código de estado

Para más detalles, véase Códigos de estado.

Código de error

Para más detalles, véase Códigos de error.