StopCrawler - 停止元数据采集器运行

更新时间:
复制 MD 格式

停止指定元数据采集器当前正在执行的运行任务。

接口说明

使用场景

停止指定元数据采集器当前正在执行的运行任务。

推荐流程

  1. 调用 ListCrawlerRuns 确认采集器存在正在执行的运行任务。

  2. 调用本接口提交停止请求。

  3. 再次调用 ListCrawlerRuns 确认最终运行状态。

版本要求

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

注意事项

没有正在执行的运行任务时调用会失败。接口成功仅表示停止请求已受理。

调试

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

调试

授权信息

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

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

Id

integer

是

元数据采集器 ID。您可以通过 ListCrawlers 查询。

1234

Id 必须对应一个当前存在运行任务的元数据采集器。

返回参数

名称

类型

描述

示例值

object

返回结果。

RequestId

string

请求 ID。用于定位日志,排查问题。

9252F32F-D855-549E-8898-61CF5A733050

Success

boolean

请求是否成功。

Id

integer

元数据采集器 ID。

1234

StopAccepted

boolean

停止请求是否已受理。true 表示已受理,最终运行状态请通过 ListCrawlerRuns 查询。

StopAccepted 表示停止请求是否已受理;请使用 ListCrawlerRuns 确认最终状态。

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

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