DeleteSemanticJob - 删除语义任务-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

按已创建任务的 Name 删除任务定义。任务正在运行时，先用该运行的 ExecutorJobId 调用 KillSemanticJob 并确认停止。

接口说明

使用场景

归档删除一个已保存的语义任务定义，使其不再出现在可用任务列表中。

调用流程

从 CreateSemanticJob.Data.Name 或 ListSemanticJobs.Data.SemanticJobs[].Name 获取任务名称。
如需确认是否存在未结束运行，先调用 ListSemanticJobRuns；必要时通过 KillSemanticJob 停止执行。
调用本接口删除任务定义。

结果说明

响应成功表示删除请求已完成；后续不能再使用该名称调用 RunSemanticJob。

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
Name	string	是	待删除任务的名称，使用 CreateSemanticJob 响应的 Data.Name 或 ListSemanticJobs 列表项的 Name。	semantic-job-demo

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

返回参数

名称	类型	描述	示例值
	object	删除语义任务的标准响应。Data 表示归档删除结果。
RequestId	string	请求 ID。用于定位日志和排查问题。	676271D6-53B4-57BE-89FA-72F7AE1418DF
Success	boolean	请求是否成功
Data	object	任务删除结果。删除不会返回可继续运行的任务定义。
Id	integer	被删除任务定义的内部唯一 ID。	1
JobName	string	删除前的原始任务名称，即本次请求的 Name。	semantic-job-demo
ArchivedJobName	string	系统为归档记录生成的任务名称，仅用于区分已删除记录，不能再用于 RunSemanticJob。	semantic-job-demo-archived
Deleted	boolean	是否已完成删除处理；为 true 表示该任务已归档删除。

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

示例

正常返回示例

JSON格式

{
  "RequestId": "676271D6-53B4-57BE-89FA-72F7AE1418DF",
  "Success": true,
  "Data": {
    "Id": 1,
    "JobName": "semantic-job-demo",
    "ArchivedJobName": "semantic-job-demo-archived",
    "Deleted": true
  }
}

错误码

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

变更历史

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