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)/ Consulta de tareas de sincronización de datos de una instancia de StarRocks
Actualización más reciente 2025-03-21 GMT+08:00
Ver PDF
Compartir

Consulta de tareas de sincronización de datos de una instancia de StarRocks

Función

Esta API se utiliza para consultar tareas de sincronización de datos de una instancia de StarRocks. Antes de invocar a esta API:

URI

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

Tabla 1 Parámetros de URI

Parámetro

Obligatorio

Tipo

Descripción

project_id

Sí

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

Sí

String

ID de instancia de StarRocks, que es compatible con el formato UUID.
Tabla 2 Parámetros de consulta

Parámetro

Obligatorio

Tipo

Descripción

limit

No

String

Número de registros que se van a consultar. Número de tareas de sincronización de datos mostradas en cada página.

offset

No

String

Desplazamiento de índice. Si offset se establece en N, la consulta comienza desde la pieza N + 1 de dato. El valor predeterminado es 0, lo que indica que la consulta comienza desde el primer dato. El valor debe ser un número pero no puede ser un número negativo.

Parámetros de solicitud

Tabla 3 Parámetros de encabezado de solicitud

Parámetro

Obligatorio

Tipo

Descripción

X-Auth-Token

Sí

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

Sí

String

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

  • en-us
  • zh-cn

Parámetros de respuesta

Código de estado: 200

Tabla 4 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

total_count

String

Número total de tareas de sincronización de datos.

replications

Array of StarRocksReplicationInfo objects

Información sobre las tareas de sincronización de datos.

ext_text

String

Campo extendido.
Tabla 5 StarRocksReplicationInfo

Parámetro

Tipo

Descripción

source_database

String

Base de datos de TaurusDB. El valor puede contener entre 3 y 1024 caracteres.

target_database

String

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

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 (_).

status

String

Estado actual.

  • Yes: normal
  • No: anormal

stage

String

Etapa de sincronización.

  • wait: esperando la sincronización
  • incremental: sincronización incremental
  • full: sincronización completa
  • cancelled: sincronización cancelada
  • paused: sincronización en pausa

percentage

String

Porcentaje de progreso.

catchup_stage

String

Etapa de recuperación.

  • wait: esperando la sincronización
  • incremental: sincronización incremental
  • full: sincronización completa
  • cancelled: sincronización cancelada
  • paused: sincronización en pausa

catchup_percentage

String

Porcentaje de progreso de recuperación.

Código de estado: 400

Tabla 6 Parámetros del cuerpo 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 7 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Ejemplo de la solicitud

Consulta de las 10 primeras tareas de sincronización en la primera página

GET https://{localhost}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication?offset=1&limit=10

Ejemplo de la respuesta

Código de estado: 200

Operación exitosa.

{
  "total_count" : 1,
  "replications" : [ {
    "source_database" : "source_database",
    "target_database" : "target_database",
    "task_name" : "task_name",
    "status" : "Yes",
    "stage" : "Incremental",
    "percentage" : 100,
    "catchup_stage" : null,
    "catchup_percentage" : 0
  } ],
  "ext_text" : null
}

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.

Tema principal: HTAP (Edición estándar)