Creación de una tarea de volcado
Función
Esta API se utiliza para crear una tarea de dumping.
URI
POST /v2/{project_id}/connectors/{connector_id}/sink-tasks
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID del proyecto |
connector_id |
Sí |
String |
ID de volcado de instancia. El valor se puede obtener de la respuesta de la API para consultar una instancia. |
Parámetros de Solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
source_type |
Sí |
String |
Tipo de datos de origen. Actualmente, solo se admite BLOB. |
task_name |
Yes |
String |
Nombre de la tarea de dumping. |
tipo_destino |
Sí |
String |
Tipo de almacenamiento Actualmente, solo se admite OBS. |
obs_destination_descriptor |
Sí |
ObsDestinationDescriptor object |
Descripción del vertedero. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
Tema |
Sí |
String |
Nombres de los temas a ser objeto de dumping. Varios temas se pueden separar por comas (,). Se admiten expresiones regulares. Valor de ejemplo: topic1,topic2. |
topics_regex |
No |
String |
La expresión regular de los temas a ser objeto de dumping. Establezca el parámetro topics_regex o el parámetro topics. No los establezcas ni los establezcas en ".*". |
consumer_strategy |
Sí |
String |
Desplazamiento de arranque de volcado.
El valor predeterminado es latest. |
destination_file_type |
Sí |
String |
Formato del archivo de volcado Actualmente, solo se admiten archivos TXT. |
access_key |
Sí |
String |
Access key ID (AK). |
secret_key |
Sí |
String |
Secret access key (SK). |
obs_bucket_name |
Sí |
String |
Nombre del depósito OBS utilizado para almacenar los datos. |
obs_path |
No |
String |
Ruta de OBS. Este parámetro se puede dejar en blanco por defecto. El valor puede contener un máximo de 64 caracteres, incluyendo letras, dígitos, guiones bajos (_), guiones y barras diagonales (/). Este parámetro se deja en blanco por defecto. |
partition_format |
No |
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 |
No |
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:
Valor predeterminado: newline (\n). |
deliver_time_interval |
Sí |
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 Unidad: segundo.
NOTA:
Este parámetro es obligatorio si streaming data se volcan a OBS. |
Parámetros de respuesta
Status code: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
task_id |
String |
ID de tarea. |
Solicitudes de Ejemplo
POST https://{endpoint}/v2/{project_id}/connectors/{connector_id}/sink-tasks { "source_type" : "BLOB", "task_name" : "obsTransfer-1122976956", "destination_type" : "OBS", "obs_destination_descriptor" : { "consumer_strategy" : "earliest", "destination_file_type" : "TEXT", "access_key" : "XXXXXXXXXXXXXXXXXXXX", "secret_key" : "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "obs_bucket_name" : "6666", "obs_path" : "obsTransfer-1122976956", "partition_format" : "yyyy/MM/dd/HH/mm", "record_delimiter" : "\n\n", "deliver_time_interval" : 300, "topics" : "topic-test" } }
Respuestas de Ejemplo
Status code: 200
Una tarea de volcado se crea correctamente.
{ "task_id" : "2962882a-386c-4c9d-bb59-3b4f55d82961" }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
Una tarea de volcado se crea correctamente. |
Códigos de error
Consulte Códigos de error.