GetCrawler - DataWorks - Centro de documentación de Alibaba Cloud

Consulta la configuración, el estado y la información de la última ejecución de un rastreador de metadatos especificado.

Descripción de la operación

Escenarios

Consulta la configuración, el estado de disponibilidad y la información de la última ejecución de un rastreador de metadatos especificado.

Flujo de trabajo recomendado

Llame a ListCrawlers para consultar los ID de los rastreadores.
Llame a esta operación para obtener los detalles del rastreador.
Para consultar el historial completo de ejecuciones, llame a ListCrawlerRuns.

Requisitos de edición

Se requiere DataWorks Basic Edition o superior.

Precauciones

Si el rastreador no se ha ejecutado, el estado de la última ejecución y el ID de la instancia de tarea pueden estar vacíos.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

dataworks:GetCrawler

get

*All Resource

*

Ninguna

Sintaxis de la solicitud

POST  HTTP/1.1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Id	integer	Sí	El ID del rastreador de metadatos. Puede llamar a ListCrawlers para consultar este ID.	1234

Puede llamar a ListCrawlers para consultar el Id.

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La respuesta.
RequestId	string	El ID de la solicitud. Se utiliza para localizar registros y solucionar problemas.	9252F32F-D855-549E-8898-61CF5A733050
Success	boolean	Indica si la solicitud fue exitosa.
Crawler	object	Los detalles del rastreador de metadatos.
Id	integer	El ID del rastreador.	1234
Name	string	El nombre del rastreador.	example_crawler
DataSourceId	integer	El ID del origen de datos.	12345
Type	string	El tipo de rastreador.	starrocks
Status	string	El estado del rastreador. El valor es VALID si la configuración del rastreador es válida y el origen de datos asociado existe. De lo contrario, el valor es INVALID.	VALID
MetaEntityId	string	El ID de metaentidad asociado con el rastreador, que se puede utilizar para conectarse a las API de consulta de metadatos.	starrocks:example-instance
ProjectId	integer	El ID del espacio de trabajo de DataWorks.	100
EnvType	string	El tipo de entorno de DataWorks. Valores válidos: Dev, Prod.	Prod
ResourceGroupId	string	El ID del grupo de recursos Serverless 2.0 utilizado para ejecutar la tarea de recolección.	Serverless_res_group_1234567890123456_1234567890
ScheduleConfig	object	La configuración de programación.
Type	string	El tipo de programación. Valores válidos: MANUAL, NORMAL.	NORMAL
CronExpress	string	La expresión cron.	0 0 2 ? * *
LastRunStatus	string	El estado de la última ejecución. Valores válidos: WAITING, RUNNING, SUCCESS, ERROR, SHUTDOWN. Este valor puede estar vacío si el rastreador no se ha ejecutado.	SUCCESS
Owner	string	El ID de usuario de DataWorks del propietario del rastreador.	1000
CreateTime	integer	La hora de creación, en marca de tiempo UNIX a nivel de milisegundos.	1710239005403
ModifyTime	integer	La hora de modificación, en marca de tiempo UNIX a nivel de milisegundos.	1710239005403
Scope	object	La configuración del alcance de recolección.
Unit	string	La granularidad del alcance de recolección. Valores válidos: PROJECT, DATABASE, INSTANCE, CATALOG.	DATABASE
Items	array	Las entradas del alcance de recolección.
	string	Una entrada individual del alcance de recolección.	example_database
ExcludeRegex	string	La expresión regular de exclusión para el alcance de recolección.	^tmp_.*
EnableAiComment	boolean	Indica si la descripción de metadatos por IA está habilitada.
Options	object	La configuración extendida para el tipo de rastreador.
	string	El valor de un elemento individual de configuración extendida para el rastreador.	true
LastRunTaskInstanceId	integer	El ID de la instancia de tarea de DataWorks asociado con la última ejecución. Este valor puede estar vacío si el rastreador no se ha ejecutado.	1234
TaskId	integer	El ID de la tarea de programación de DataWorks asociado con el rastreador, que se puede utilizar para llamar a GetTask y consultar la definición de la tarea.	1234

El objeto Crawler devuelve la configuración del rastreador, el estado de disponibilidad y la información de la última ejecución.

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "9252F32F-D855-549E-8898-61CF5A733050",
  "Success": false,
  "Crawler": {
    "Id": 1234,
    "Name": "example_crawler",
    "DataSourceId": 12345,
    "Type": "starrocks",
    "Status": "VALID",
    "MetaEntityId": "starrocks:example-instance",
    "ProjectId": 100,
    "EnvType": "Prod",
    "ResourceGroupId": "Serverless_res_group_1234567890123456_1234567890",
    "ScheduleConfig": {
      "Type": "NORMAL",
      "CronExpress": "0 0 2 ? * *"
    },
    "LastRunStatus": "SUCCESS",
    "Owner": "1000",
    "CreateTime": 1710239005403,
    "ModifyTime": 1710239005403,
    "Scope": {
      "Unit": "DATABASE",
      "Items": [
        "example_database"
      ],
      "ExcludeRegex": "^tmp_.*"
    },
    "EnableAiComment": false,
    "Options": {
      "key": "true"
    },
    "LastRunTaskInstanceId": 1234,
    "TaskId": 1234
  }
}

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.