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

Consulta los tipos de rastreadores admitidos en la región actual, junto con su alcance de recolección, programación y capacidades de configuración de extensiones.

Descripción de la operación

Escenarios

Consulta los tipos de rastreadores que se pueden crear en la región actual, así como los orígenes de datos, el alcance de recolección, los grupos de recursos, la programación, la descripción de metadatos mediante IA y las capacidades de configuración de extensiones que admite cada tipo.

Flujo de trabajo recomendado

Ejecute esta operación antes de crear o actualizar un rastreador.
Construya una solicitud CreateCrawler o UpdateCrawler basándose en la información de capacidades devuelta.

Requisitos de edición

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

Precauciones

Las capacidades pueden variar según la región y el tipo de rastreador. Utilice la respuesta real de esta operación como referencia.

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

get

*All Resource

*

Ninguna

Sintaxis de la solicitud

GET  HTTP/1.1

Parámetros de la solicitud

Parámetro

Tipo

Obligatorio

Descripción

Ejemplo

Esta operación no requiere parámetros de solicitud de negocio.

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.
CrawlerTypes	array<object>	La lista de tipos de rastreador y capacidades admitidas en la región actual.
	array<object>	La información de capacidad de un solo tipo de rastreador.
Type	string	El tipo de rastreador.	holo
DisplayName	string	El nombre para mostrar.	Hologres
SupportedEntityTypes	array<object>	Los niveles de entidades de metadatos que el tipo de rastreador admite para la recolección.
	object	Un nivel de entidad de metadatos individual.
Type	string	El identificador de tipo de entidad de metadatos.	holo
SubType	string	El subtipo de entidad de metadatos.	database
Optional	boolean	Indica si el nivel de entidad de metadatos es opcional.
ParentSubType	string	El subtipo de entidad de metadatos de nivel superior.	instance
SupportedScopeUnits	array	La lista de granularidades de alcance de recolección admitidas.
	string	Una granularidad de alcance de recolección individual.	DATABASE
DefaultScopeUnit	string	La granularidad de alcance de recolección predeterminada.	DATABASE
SupportedOptionKeys	array<object>	Los elementos de configuración de extensión de rastreador admitidos.
	object	Un elemento de configuración de extensión de rastreador individual.
Key	string	El nombre del elemento de configuración de extensión.	CollectRecyclebin
ValueType	string	El tipo de valor del elemento de configuración de extensión, como BOOLEAN.	BOOLEAN
Required	boolean	Indica si el elemento de configuración de extensión es obligatorio.
DefaultValue	string	El valor predeterminado del elemento de configuración de extensión.	false
AllowedValues	array	La lista de valores permitidos para el elemento de configuración de extensión.
	string	Un valor permitido individual para el elemento de configuración de extensión.	true
SupportExcludeRegex	boolean	Indica si se admiten expresiones regulares de exclusión de esquemas o tablas.
SupportSchedule	boolean	Indica si se admite la programación periódica.
SupportAiComment	boolean	Indica si se admite la descripción de metadatos mediante IA.
RequireResourceGroup	boolean	Indica si se debe especificar un grupo de recursos al crear este tipo de rastreador.
SupportedDatasourceTypes	array	La lista de tipos de origen de datos admitidos.
	string	Un tipo de origen de datos individual.	holo

CrawlerTypes contiene únicamente los tipos de rastreador que se pueden crear en la región actual.

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "9252F32F-D855-549E-8898-61CF5A733050",
  "Success": false,
  "CrawlerTypes": [
    {
      "Type": "holo",
      "DisplayName": "Hologres",
      "SupportedEntityTypes": [
        {
          "Type": "holo",
          "SubType": "database",
          "Optional": false,
          "ParentSubType": "instance"
        }
      ],
      "SupportedScopeUnits": [
        "DATABASE"
      ],
      "DefaultScopeUnit": "DATABASE",
      "SupportedOptionKeys": [
        {
          "Key": "CollectRecyclebin",
          "ValueType": "BOOLEAN",
          "Required": false,
          "DefaultValue": "false",
          "AllowedValues": [
            "true"
          ]
        }
      ],
      "SupportExcludeRegex": false,
      "SupportSchedule": false,
      "SupportAiComment": false,
      "RequireResourceGroup": false,
      "SupportedDatasourceTypes": [
        "holo"
      ]
    }
  ]
}

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.