更新时间:2023-05-24 GMT+08:00
分享

删除作业

功能介绍

该接口用于删除作业以及作业产生的数据。

URI

DELETE /v1/{project_id}/del-job

参数说明请参见表1

表1 URI参数说明

名称

是否必选

类型

说明

project_id

String

项目编号,用于资源隔离。获取方法请参见获取项目ID

job_id

String

训练作业ID。

请求消息

请求参数请参见表2

表2 请求参数说明

参数名称

是否必选

参数类型

说明

job_id

String

作业ID,只能由字母、数字、中划线和下划线组成,并且长度为1~20个字符。

type

String

作业类型。

offline_platform

Object

计算平台信息,type为etl/recall/filter/standard必填,为其他时不必填。

offline_platform包含参数如下:

  • platform,参数类型String,非必选参数,平台名称,支持DLI
  • platform_parameter,参数类型String,非必选参数,平台信息。platform_parameter包含参数cluster_name
    • cluster_name,参数类型String,必选参数,集群名称。
  • config_load_path,参数类型String,非必选参数,配置加载路径。

响应消息

响应参数请参见表3

表3 响应参数说明

参数名称

是否必选

参数类型

说明

is_success

Boolean

是否成功。

message

String

消息提示。

error_code

String

请求失败时的错误码,请求成功时无此字段。

error_msg

String

请求失败时的错误信息,请求成功时无此字段。

示例

  • 请求示例
    {
      "job_id": "aa22ac78f14142eaa7deacc8e88d477e",
      "type":"etl",
      "offline_platform": {
           "platform": "DLI", 
         "platform_parameter": {"cluster_name":"res_one"}, 
         "config_load_path": "<配置源路径>"
        }
    }
  • 成功响应示例
    {
        "is_success": true,
        "message": "Succeed to delete train log."
    }
  • 失败响应示例
    {
        "is_success": false,
        "error_code": "res.2301",
        "error_msg": "Failed to resolve the token from the request."
    }

状态码

状态码请参见状态码

相关文档