RunCrawler - 运行元数据采集器-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

接口说明

使用场景

提交指定元数据采集器的运行请求。

版本要求

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

费用说明

运行采集任务会使用计算资源，可能产生费用，具体以实际使用的资源组和 DataWorks 计费规则为准。

当采集器已开启 AI 元数据描述能力（EnableAiComment=true）时，采集元数据并生成 AI 说明会消耗 Token。Token 赠送额度及超出额度后的计费规则，请参见 Data Agent 费用。

注意事项

接口成功仅表示运行请求已受理，不表示采集任务已经完成。

调试

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

调试

授权信息

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

请求语法

POST  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
Id	integer	是	元数据采集器 ID。您可以通过 ListCrawlers 查询。	1234

Id 可通过 ListCrawlers 查询。

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。用于定位日志，排查问题。	9252F32F-D855-549E-8898-61CF5A733050
Success	boolean	请求是否成功。
Id	integer	元数据采集器 ID。	1234
RunAccepted	boolean	运行请求是否已受理。true 表示已受理，不表示采集任务已经完成。
RunStatus	string	提交后的初始运行状态。运行请求成功受理时为 WAITING；最终状态请通过 ListCrawlerRuns 查询。	WAITING
TaskInstanceId	integer	关联的 DataWorks 任务实例 ID。该字段可能为空，最终运行记录请通过 ListCrawlerRuns 查询。	1234

RunAccepted 表示运行请求是否已受理；请使用 ListCrawlerRuns 查询最终状态。TaskInstanceId 可能为空。

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

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