全部产品
Search
文档中心

大数据开发治理平台 DataWorks:KillSemanticJob - 停止语义任务运行

更新时间:Sep 03, 2026

使用 RunSemanticJob 或 ListSemanticJobRuns 返回的 ExecutorJobId 停止指定运行。调用成功仅表示停止请求已受理,最终状态请通过 GetSemanticJobDetail 查询。

接口说明

使用场景

向执行器发起停止指定语义任务运行的请求,适用于任务长时间运行、需要人工中止或资源回收的场景。

调用流程

  1. 从 RunSemanticJob 或 ListSemanticJobRuns 获取 ExecutorJobId,并使用任务的 ProjectId。

  2. 可按需要传入 RetryTimes。

  3. 调用后使用 GetSemanticJobDetail 轮询最终状态,必要时读取 GetSemanticJobLog 诊断。

注意事项

接口成功仅表示停止请求已被处理,不等同于任务已经进入终态。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:KillSemanticJob

update

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

ExecutorJobId

string

是

待停止运行的执行器任务标识,使用 RunSemanticJob 响应的 Data.ExecutorJobId 或 ListSemanticJobRuns 记录中的 ExecutorJobId。

exec-job-demo

ProjectId

integer

是

待停止任务所属的 DataWorks 工作空间 ID,使用 CreateSemanticJob 响应或 ListSemanticJobs 列表项的 ProjectId。

100

RetryTimes

integer

否

向执行器发起停止请求时使用的重试次数。通常可省略;传入时使用非负整数,并在调用后通过 GetSemanticJobDetail 确认最终状态。

1

请根据各请求字段的说明构造调用参数。

返回参数

名称

类型

描述

示例值

object

停止运行请求的标准响应。Data 只表示请求处理结果,不表示任务已经进入终态。

RequestId

string

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

676271D6-53B4-57BE-89FA-72F7AE1418DF

Success

boolean

请求是否成功

Data

boolean

停止请求是否已被执行器受理;返回 true 后仍应使用 GetSemanticJobDetail 查询最终状态。

响应字段含义和后续调用关系请参阅各字段说明。

示例

正常返回示例

JSON格式

{
  "RequestId": "676271D6-53B4-57BE-89FA-72F7AE1418DF",
  "Success": true,
  "Data": true
}

错误码

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

变更历史

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