GetCrawlerTypeCapabilities - 查询采集器类型能力 - 大数据开发治理平台 DataWorks

查询当前地域支持创建的采集器类型及其采集范围、调度和扩展配置能力。

接口说明

使用场景

查询当前地域支持创建的采集器类型，以及各类型支持的数据源、采集范围、资源组、调度、AI 元数据描述和扩展配置能力。

版本要求

需要购买 DataWorks 基础版及以上版本才能使用。

注意事项

不同地域和采集器类型的能力可能不同，请以本接口的实际返回结果为准。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

GET  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

本接口无需业务请求参数。

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。用于定位日志，排查问题。	9252F32F-D855-549E-8898-61CF5A733050
Success	boolean	请求是否成功。
CrawlerTypes	array<object>	当前地域支持创建的采集器类型及能力列表。
	array<object>	单个采集器类型的能力信息。
Type	string	采集器类型	holo
DisplayName	string	展示名称	Hologres
SupportedEntityTypes	array<object>	该采集器类型支持采集的元数据实体层级。
	object	单个元数据实体层级。
Type	string	元数据实体类型标识。	holo
SubType	string	元数据实体子类型。	database
Optional	boolean	该元数据实体层级是否可选。
ParentSubType	string	父层级元数据实体子类型。	instance
SupportedScopeUnits	array	支持的采集范围粒度列表。
	string	单个采集范围粒度。	DATABASE
DefaultScopeUnit	string	默认采集范围粒度。	DATABASE
SupportedOptionKeys	array<object>	支持的采集器扩展配置项。
	object	单个采集器扩展配置项。
Key	string	扩展配置项名称。	CollectRecyclebin
ValueType	string	扩展配置项的值类型，例如 BOOLEAN。	BOOLEAN
Required	boolean	扩展配置项是否必填。
DefaultValue	string	扩展配置项的默认值。	false
AllowedValues	array	扩展配置项允许的值列表。
	string	扩展配置项允许的单个值。	true
SupportExcludeRegex	boolean	是否支持 schema 或 table 排除正则
SupportSchedule	boolean	是否支持周期调度
SupportAiComment	boolean	是否支持 AI 元数据描述。
RequireResourceGroup	boolean	创建该类型采集器时是否必须指定资源组。
SupportedDatasourceTypes	array	支持的数据源类型列表。
	string	单个数据源类型。	holo

CrawlerTypes 只包含当前地域支持创建的采集器类型。

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

大数据开发治理平台 DataWorks：GetCrawlerTypeCapabilities - 查询采集器类型能力