更新时间:2022-04-12 GMT+08:00
分享

取消Job(1.0.0)

功能介绍

用于取消已经提交的作业。

对点过滤查询、边过滤查询、执行算法和增加索引4种类型的异步API返回的jobId,支持取消。若作业已经执行结束或失败则无法取消。

只有点过滤查询、边过滤查询、执行算法、增加索引返回的Job支持取消。其他类型的会报“Unsupported Operation”异常。

URI

  • URI 格式
    DELETE /ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id}
  • 参数说明
    表1 URI参数说明

    参数

    是否必选

    类型

    说明

    project_id

    String

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

    job_id

    String

    Job ID。

    graph_name

    String

    图名称。

请求

  • 请求样例
    DELETE http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id}

    SERVER_URL:图的访问地址,取值请参考业务面API使用限制

响应

  • 要素说明
    表2 要素说明

    参数

    是否必选

    类型

    说明

    errorMessage

    String

    系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误信息。

    errorCode

    String

    系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误码。

  • 请求成功样例
    Http Status Code: 200
    {}
  • 请求失败样例
    Http Status Code: 400
    {
     
    "errorMessage": "can not find job to cancel, id is 9440a7ebXXXXXXXXXXXXXXXXXXXX2d079a67001679122",
     
    "errorCode": "GES.8303"
    }

返回值

  • 正常

    200

  • 异常
    表3 异常返回值说明

    返回值

    说明

    400 Bad Request

    请求错误。

    401 Unauthorized

    鉴权失败。

    403 Forbidden

    没有操作权限。

    404 Not Found

    找不到资源。

    500 Internal Server Error

    服务内部错误。

    503 Service Unavailable

    服务不可用。

分享:

    相关文档

    相关产品

close