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/Distributed Message Service for Kafka/Referencia de la API/APIs V2 (Recomendado)/Gestión de volcado/Consulta de una tarea de volcado
Actualización más reciente 2022-11-07 GMT+08:00
Ver PDF
Compartir

Consulta de una tarea de volcado

Función

Esta API se utiliza para consultar una tarea de dumping.

URI

GET /v2/{project_id}/connectors/{connector_id}/sink-tasks/{task_id}

Tabla 1 Parámetros de ruta

Parámetro

Obligatorio

Tipo

Descripción

project_id

Sí

String

ID del proyecto del inquilino.

connector_id

Sí

String

ID de volcado de instancia. El valor se puede obtener de la respuesta de la API para consultar una instancia.

task_id

Yes

String

ID de tarea de volcado.

Tabla 2 Parámetros de consulta

Parámetro

Obligatorio

Tipo

Descripción

topic-info

No

String

Si la información del tema está contenida. El valor predeterminado es false.

Parámetros de Solicitud

Ninguno

Parámetros de respuesta

Status code: 200

Tabla 3 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

task_name

String

Nombre de la tarea de dumping.

destination_type

String

Tipo de tarea de dumping.

create_time

Long

Hora en la que se crea la tarea de volcado.

status

String

Estado de la tarea de volcado.

topics

String

Lista de temas o expresión regular de tema de la tarea volcada.

obs_destination_descriptor

obs_destination_descriptor object

Descripción del vertedero.

topics_info

Array of topics_info objects

Información sobre el tema.

Tabla 4 obs_destination_descriptor

Parámetro

Tipo

Descripción

consumer_strategy

String

Política de consumo de mensajes:

  • latest: Los mensajes se consumen desde el final del tema.
  • earliest:Los mensajes se consumen desde el inicio del tema.

El valor predeterminado es latest.

destination_file_type

String

Formato del archivo de volcado Actualmente, solo se admite TXT.

obs_bucket_name

String

Nombre del depósito OBS utilizado para almacenar los datos.

obs_path

String

Ruta de OBS.

partition_format

String

Estructura de directorios del archivo objeto escrito en OBS. La estructura de directorios tiene el formato yyyy/MM/dd/HH/mm (hora en la que se creó la tarea de volcado). - N/A: Si este campo se deja sin especificar, no se utilizará el formato de directorio de tiempo. -yyyy: año. - yyyy/MM: año y mes. - yyyy/MM/dd: año, mes y día. - yyyy/MM/dd/HH: año, mes, día y hora. - yyyy/MM/dd/HH/mm: año, mes, día, hora y minuto. Por ejemplo, 2017/11/10/14/49 significa que la estructura de directorios es 2017 > 11 > 10 > 14 > 49, donde 2017 es la carpeta más externa.Valor predeterminado: vacío.> Después de que los datos son volcados con éxito, la estructura del directorio de almacenamiento es obs_bucket_path/file_prefix/partition_format. La zona horaria predeterminada es GMT+08:00.

record_delimiter

String

Delimitador para el archivo de volcado, que se utiliza para separar los datos de usuario que se escriben en el archivo de volcado. Opciones:

  • Coma (,)
  • Punto y coma (;)
  • Barra vertical (|)
  • Nueva línea (\n)
  • Vacío

Valor predeterminado: newline (\n).

deliver_time_interval

Integer

Intervalo definido por el usuario en el que se importan los datos a OBS. Si no se introducen datos durante el intervalo actual, no se generará ningún paquete de archivo de volcado. Rango de valores: 30 a 900. Valor predeterminado: 300. Unidad: segundo.

NOTA:

Este parámetro es obligatorio si streaming data se volcan a OBS.

obs_part_size

Long

Tamaño (en bytes) de cada archivo que se va a cargar. Valor predeterminado: 5242880.

Tabla 5 topics_info

Parámetro

Tipo

Descripción

topic

String

Nombre del tema.

partitions

Array of partitions objects

Lista de particiones.

Tabla 6 partitions

Parámetro

Tipo

Descripción

partition_id

String

ID de la partición.

status

String

Estado de funcionamiento.

last_transfer_offset

String

Desplazamiento de los mensajes volcados.

log_end_offset

String

Desplazamiento de mensaje.

lag

String

Número de mensajes apilados.

Solicitudes de Ejemplo

GET https://{endpoint}/v2/{project_id}/connectors/{connector_id}/sink-tasks/{task_id}?topic-info=true

Respuestas de Ejemplo

Status code: 200

La tarea de volcado se consulta correctamente.

{
  "task_name" : "obsTransfer-56997523",
  "destination_type" : "OBS",
  "create_time" : 1628126621283,
  "status" : "RUNNING",
  "topics" : "topic-sdk-no-delete",
  "obs_destination_descriptor" : {
    "consumer_strategy" : "earliest",
    "destination_file_type" : "TEXT",
    "obs_bucket_name" : "testobs",
    "obs_path" : "obsTransfer-56997523",
    "partition_format" : "yyyy/MM/dd/HH/mm",
    "record_delimiter" : "\n\n",
    "deliver_time_interval" : 300,
    "obs_part_size" : 5242880,
    "partitioner_class" : "io.confluent.connect.storage.partitioner.TimeBasedPartitioner"
  },
  "topics_info" : [ {
    "topic" : "topic-sdk-no-delete",
    "partitions" : [ {
      "partition_id" : "2",
      "status" : "RUNNING",
      "last_transfer_offset" : "3",
      "log_end_offset" : "3",
      "lag" : "0"
    }, {
      "partition_id" : "1",
      "status" : "RUNNING",
      "last_transfer_offset" : "3",
      "log_end_offset" : "3",
      "lag" : "0"
    }, {
      "partition_id" : "0",
      "status" : "RUNNING",
      "last_transfer_offset" : "3",
      "log_end_offset" : "3",
      "lag" : "0"
    } ]
  } ]
}

Códigos de estado

Código de estado

Descripción

200

La tarea de volcado se consulta correctamente.

Códigos de error

Consulte Códigos de error.

Tema principal:Gestión de volcado