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

Actualiza el grupo de recursos, el alcance de la recolección, la programación y las configuraciones de extensión de un rastreador de metadatos especificado.

Descripción de la operación

Escenarios

Actualiza parcialmente el grupo de recursos, el alcance de la recolección, la programación, la descripción de metadatos con IA o las configuraciones de extensión de un rastreador de metadatos especificado.

Flujo de trabajo recomendado

Llame a GetCrawler para consultar las configuraciones actuales.
Llame a GetCrawlerTypeCapabilities para verificar las capacidades de configuración admitidas por el tipo de rastreador.
Llame a esta operación únicamente con los campos que desea actualizar.

Requisitos de edición

Se requiere DataWorks Basic Edition o una edición superior.

Precauciones

Debe proporcionar al menos un campo actualizable. Los campos que no se proporcionen permanecerán sin cambios.

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:UpdateCrawler

update

*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 los ID de los rastreadores.	1234
ResourceGroupId	string	No	El ID del grupo de recursos Serverless 2.0 utilizado para ejecutar la tarea de recolección. La compatibilidad y obligatoriedad de este parámetro dependen de las capacidades devueltas por GetCrawlerTypeCapabilities. Si no se especifica este parámetro, el valor existente permanece sin cambios.	Serverless_res_group_1234567890123456_1234567890
Scope	object	No	La configuración del alcance de la recolección. Si se especifica este parámetro, se actualiza el alcance de la recolección. Si no se especifica este parámetro, el valor existente permanece sin cambios.
Unit	string	Sí	La granularidad del alcance de la recolección. Los valores válidos están determinados por SupportedScopeUnits devuelto por GetCrawlerTypeCapabilities.	DATABASE
Items	array	No	La lista de nombres de bases de datos. Este parámetro solo es compatible cuando Unit se establece en DATABASE. Se permite un máximo de 1,000 entradas. Los nombres no pueden estar vacíos ni duplicados.
	string	No	Un nombre de base de datos individual. El nombre puede tener una longitud máxima de 256 caracteres.	example_database
ExcludeRegex	string	No	La expresión regular utilizada para excluir objetos del alcance de la recolección. Este parámetro solo es compatible cuando SupportExcludeRegex devuelto por GetCrawlerTypeCapabilities se establece en true.	^tmp_.*
ScheduleConfig	object	No	La configuración de programación. Si se especifica este parámetro, se actualiza el método de programación. Si no se especifica este parámetro, el valor existente permanece sin cambios.
Type	string	Sí	El tipo de programación. MANUAL indica ejecución manual. NORMAL indica programación periódica. Los orígenes de datos en el entorno de desarrollo solo admiten MANUAL. La disponibilidad de NORMAL depende del valor SupportSchedule devuelto por GetCrawlerTypeCapabilities.	NORMAL
CronExpress	string	No	La expresión cron de seis campos para la programación periódica. Este parámetro es obligatorio cuando Type se establece en NORMAL. El campo de segundos debe ser 0 y la frecuencia de programación no puede exceder una vez por hora.	0 0 2 ? * *
EnableAiComment	boolean	No	Especifica si se debe habilitar la descripción de metadatos con IA. Este parámetro solo es compatible cuando SupportAiComment devuelto por GetCrawlerTypeCapabilities se establece en true. Si no se especifica este parámetro, el valor existente permanece sin cambios.
Options	object	No	Las configuraciones de extensión para el tipo de rastreador. Solo se actualizan los elementos de configuración especificados. Los elementos de configuración no especificados permanecen sin cambios. Las claves y valores admitidos están determinados por SupportedOptionKeys devuelto por GetCrawlerTypeCapabilities.
	string	No	El valor de un elemento de configuración de extensión del rastreador individual. Los elementos de configuración admitidos, los tipos de valor y los rangos de valor están determinados por SupportedOptionKeys devuelto por GetCrawlerTypeCapabilities.	v1

Debe proporcionar al menos uno de los siguientes parámetros: ResourceGroupId, Scope, ScheduleConfig, EnableAiComment u Options. Los campos que no se proporcionen permanecerán sin cambios.

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La respuesta.
RequestId	string	El ID de la solicitud. Puede utilizar este ID para localizar registros y solucionar problemas.	9252F32F-D855-549E-8898-61CF5A733050
Success	boolean	Indica si la solicitud se realizó correctamente.
Id	integer	El ID del rastreador de metadatos actualizado.	1234

Id es el ID del rastreador de metadatos actualizado.

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "9252F32F-D855-549E-8898-61CF5A733050",
  "Success": false,
  "Id": 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.