更新时间:2025-11-04 GMT+08:00
分享

停止作业 - StopJob

功能介绍

本接口用于停止调度一个作业。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

  • URI格式

    POST /v1/{project_id}/jobs/{job_name}/stop

  • 参数说明
    表1 URI参数说明

    参数名

    是否必选

    参数类型

    说明

    project_id

    String

    项目编号,获取方法请参见项目ID和账号ID

    job_name

    String

    作业名称。

请求参数

表2 请求Header参数

参数名

是否必选

参数类型

说明

workspace

String

工作空间id。

  • 如果不设置该参数,默认查询default工作空间下的数据。
  • 如果需要查询其他工作空间的数据,需要带上该消息头。
    说明:
    • 多个DataArts Studio实例需要指定工作空间。
    • 当工作空间里面没有default工作空间时,工作空间为必填参数,否则会报错。

响应参数

请求示例

停止作业myJob。
POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/myJob/stop

响应示例

  • 成功响应

    HTTP状态码 204

  • 失败响应

    HTTP状态码 400

    {
        "error_code":"DLF.0100",
        "error_msg":"The job does not exists."
    }

相关文档