UpdateCrawler - 更新元数据采集器 - 大数据开发治理平台 DataWorks

更新指定元数据采集器的资源组、采集范围、调度和扩展配置。

接口说明

使用场景

部分更新指定元数据采集器的资源组、采集范围、调度、AI 元数据描述或扩展配置。

版本要求

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

注意事项

至少需要提供一个可更新字段；未提供的字段保持不变。

调试

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

调试

授权信息

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

请求语法

POST  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
Id	integer	是	元数据采集器 ID。您可以通过 ListCrawlers 查询。	1234
ResourceGroupId	string	否	运行采集任务使用的 Serverless 2.0 资源组 ID。是否支持以及是否需要填写以 GetCrawlerTypeCapabilities 返回的能力为准；未传入时保持不变。	Serverless_res_group_1234567890123456_1234567890
Scope	object	否	采集范围配置。传入时更新采集范围；未传入时保持不变。
Unit	string	是	采集范围粒度。可选值以 GetCrawlerTypeCapabilities 返回的 SupportedScopeUnits 为准。	DATABASE
Items	array	否	数据库名称列表。仅当 Unit 为 DATABASE 时支持填写，最多 1000 个，名称不能为空或重复。
	string	否	单个数据库名称，长度不超过 256 个字符。	example_database
ExcludeRegex	string	否	采集范围排除正则表达式。仅当 GetCrawlerTypeCapabilities 返回的 SupportExcludeRegex 为 true 时支持。	^tmp_.*
ScheduleConfig	object	否	调度配置。传入时更新调度方式；未传入时保持不变。
Type	string	是	调度类型。MANUAL 表示手动运行，NORMAL 表示周期调度。开发环境数据源仅支持 MANUAL；NORMAL 是否可用以 GetCrawlerTypeCapabilities 返回的 SupportSchedule 为准。	NORMAL
CronExpress	string	否	周期调度的六段式 Cron 表达式。Type 为 NORMAL 时必填；秒位必须为 0，调度频率不得高于每小时一次。	0 0 2 ? * *
EnableAiComment	boolean	否	是否启用 AI 元数据描述。仅当 GetCrawlerTypeCapabilities 返回的 SupportAiComment 为 true 时支持；未传入时保持不变。
Options	object	否	采集器类型的扩展配置。仅更新传入的配置项，未传入的配置项保持不变；支持的键和值以 GetCrawlerTypeCapabilities 返回的 SupportedOptionKeys 为准。
	string	否	单个采集器扩展配置项的值。支持的配置项、值类型和取值范围以 GetCrawlerTypeCapabilities 返回的 SupportedOptionKeys 为准。	v1

至少提供 ResourceGroupId、Scope、ScheduleConfig、EnableAiComment 或 Options 中的一项。未提供的字段保持不变。

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。用于定位日志，排查问题。	9252F32F-D855-549E-8898-61CF5A733050
Success	boolean	请求是否成功。
Id	integer	更新后的元数据采集器 ID。	1234

Id 为更新后的元数据采集器 ID。

示例

正常返回示例

JSON格式

{
  "RequestId": "9252F32F-D855-549E-8898-61CF5A733050",
  "Success": true,
  "Id": 1234
}

错误码

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

变更历史

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

大数据开发治理平台 DataWorks：UpdateCrawler - 更新元数据采集器