文档首页/ 图引擎服务 GES/ API参考/ 业务面API/ 持久化版/ HyG Job管理API/ 取消HyG Job
更新时间：2024-07-26 GMT+08:00
查看PDF
分享

取消HyG Job

功能介绍

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

注意：取消运行中的作业，作业不会立即终止，可能存在延时。

URI

DELETE /ges/v1.0/{project_id}/hyg/{graph_name}/jobs/{job_id}
表1 路径参数

参数

是否必选

类型

说明

project_id

是

String

项目ID。获取方法请参见获取项目ID。

graph_name

是

String

图名称。

job_id

是

String

响应结果中的算法任务Job ID。

请求参数

无

响应参数

表2 响应Body参数

参数

类型

说明

errorMessage

String

系统提示信息。

  • 执行成功时，字段可能为空。
  • 执行失败时，用于显示错误信息。

errorCode

String

系统提示信息。

  • 执行成功时，字段可能为空。
  • 执行失败时，用于显示错误码。

result

String

执行结果。

  • 成功时，result值为success。
  • 失败时，result值为failed。

请求示例

  • 请求示例1：取消已经提交的某个作业。 
    DELETE http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id}
  • 请求示例2：取消全部排队中的作业。 
    DELETE http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/jobs

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

响应示例

状态码： 200

成功响应示例

Http Status Code: 200
{
    "result": "success"
}

状态码： 400

失败响应示例

HttpStatusCode: 400
{
"errorMessage": "Graph [
{project_id}
-movie1] does not exist, please check project_id and graph_name.",
"errorCode": "GES.8000",
"result": "failed"
}

状态码

返回值

说明

400 Bad Request

请求错误。

401 Unauthorized

鉴权失败。

403 Forbidden

没有操作权限。

404 Not Found

找不到资源。

500 Internal Server Error

服务内部错误。

503 Service Unavailable

服务不可用。

错误码

请参见错误码。

父主题： HyG Job管理API