GetCrawlerTypeCapabilities-DataWorks(DataWorks)-阿里云帮助中心

Queries the crawler types supported in the current region, along with their collection scope, scheduling, and extension configuration capabilities.

Operation description

Scenarios

Queries the crawler types that can be created in the current region, as well as the data sources, collection scope, resource groups, scheduling, AI metadata description, and extension configuration capabilities supported by each type.

Recommended workflow

Call this operation before creating or updating a crawler.
Construct a CreateCrawler or UpdateCrawler request based on the returned capability information.

Edition requirements

DataWorks Basic Edition or a higher edition is required.

Precautions

Capabilities may vary by region and crawler type. Use the actual response of this operation as the reference.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

This operation does not require business request parameters.

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID. Used for locating logs and troubleshooting issues.	9252F32F-D855-549E-8898-61CF5A733050
Success	boolean	Indicates whether the request was successful.
CrawlerTypes	array<object>	The list of crawler types and capabilities supported in the current region.
	array<object>	The capability information of a single crawler type.
Type	string	The crawler type.	holo
DisplayName	string	The display name.	Hologres
SupportedEntityTypes	array<object>	The metadata entity levels that the crawler type supports for collection.
	object	A single metadata entity level.
Type	string		holo
SubType	string		database
Optional	boolean
ParentSubType	string		instance
SupportedScopeUnits	array	The list of supported collection scope granularities.
	string	A single collection scope granularity.	DATABASE
DefaultScopeUnit	string	The default collection scope granularity.	DATABASE
SupportedOptionKeys	array<object>	The supported crawler extension configuration items.
	object	A single crawler extension configuration item.
Key	string		CollectRecyclebin
ValueType	string		BOOLEAN
Required	boolean
DefaultValue	string		false
AllowedValues	array
	string		true
SupportExcludeRegex	boolean	Indicates whether schema or table exclusion regular expressions are supported.
SupportSchedule	boolean	Indicates whether periodic scheduling is supported.
SupportAiComment	boolean	Indicates whether AI metadata description is supported.
RequireResourceGroup	boolean	Indicates whether a resource group must be specified when creating this type of crawler.
SupportedDatasourceTypes	array	The list of supported data source types.
	string	A single data source type.	holo

CrawlerTypes contains only the crawler types that can be created in the current region.

Examples

Success response

JSON format

{
  "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"
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.