文档首页 > > API参考> 管理面API> 任务中心API>

查询Job状态(1.0.0)-管理面

查询Job状态(1.0.0)-管理面

分享
更新时间:2020/12/14 GMT+08:00

功能介绍

查询Job的执行状态。对创建图、关闭图、启动图、删除图、导入图等异步API命令下发后,会返回jobId,通过jobId查询任务的执行状态。

URI

  • URI 格式
    GET /v1.0/{projectId}/graphs/{graphId}/jobs/{jobId}/status
  • 参数说明
    表1 URI参数说明

    参数

    是否必选

    类型

    说明

    projectId

    String

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

    graphId

    String

    图ID。

    jobId

    String

    Job ID。

请求

  • 请求样例
    GET    https://Endpoint/v1.0/{projectId}/graphs/{graphId}/jobs/{jobId}/status

响应

  • 要素说明
    表2 要素说明

    参数

    是否必选

    类型

    说明

    errorMessage

    String

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

    errorCode

    String

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

    Job属性列表

    Json

    参照表3 job属性列表

    表3 job属性列表

    参数

    是否必选

    类型

    说明

    jobId

    String

    任务ID。

    status

    String

    任务状态。

    • pending:等待中
    • running:运行中
    • success:成功
    • failed:失败

    jobType

    String

    任务类型。

    jobName

    JsonArray

    任务名称。

    relatedGraph

    String

    关联图名称。

    beginTime

    String

    任务开始时间,格式为UTC,"yyyy-MM-dd'T'HH:mm:ss"

    endTime

    String

    任务结束时间,格式为UTC,"yyyy-MM-dd'T'HH:mm:ss"

    jobDetail

    JobDetail数据结构

    只有jobName为ImportGraph时才返回,用于显示导入图详情。

    failReason

    String

    任务失败原因

    jobProgress

    Double

    任务执行进度,预留字段,暂未使用。

    表4 JobDetail数据结构

    参数

    是否必选

    类型

    说明

    schemaPath

    JsonArray

    元数据OBS路径。

    edgesetPath

    JsonArray

    边数据集OBS路径。

    vertexsetPath

    JsonArray

    点数据集OBS路径。

    表5 edgesetPath和vertexsetPath属性列表

    参数

    是否必选

    类型

    说明

    path

    String

    OBS文件路径。

    log

    String

    导入OBS文件操作的日志存储文件。

    status

    String

    导入OBS文件操作的状态。

    • success:完全成功
    • failed:完全失败
    • partFailed:部分成功

    cause

    String

    导入失败原因。

    totalLines

    Long

    导入总行数。其值为-1时表示当前版本没有返回该字段。

    failedLines

    Long

    导入失败行数。其值为-1时表示当前版本没有返回该字段。

    successfulLines

    Long

    导出成功行数。其值为-1时表示当前版本没有返回该字段。

    表6 schemaPath属性列表

    参数

    是否必选

    类型

    说明

    path

    String

    OBS文件路径。

    log

    String

    导入OBS文件操作的日志存储文件。

    status

    String

    导入OBS文件操作的状态。

    • success:完全成功
    • failed:完全失败
    • partFailed:部分成功

    cause

    String

    导入失败原因。

  • 请求成功样例
    Http Status Code: 200
    {
      "jobId": "ff80808167f09aaa0167f19b35ec0305",
      "status": "success",
      "jobType": "GraphManagement",
      "jobName": "ImportGraph",
      "relatedGraph": "GES_UI_AUTO",
      "beginTime": "2018-11-27T21:39:00",
      "endTime": "2018-11-27T21:39:56",
      "jobDetail": {
        "vertexsetPath": [
          {
            "path": "ges-ui/auDatas/list_set_vertex.csv",
            "log": null,
            "cause": null,
            "status": "success"
          }
        ],
        "edgesetPath": [
          {
            "path": "ges-ui/auDatas/list_set_edge.csv",
            "log": null,
            "cause": null,
            "status": "success"
          }
        ],
        "schemaPath": [
          {
            "path": "ges-ui/auDatas/list_set_schema.xml",
            "log": null,
            "cause": null,
            "status": "success"
          }
        ]
      },
      "jobProgress": 0
    }
  • 请求失败样例
    Http Status Code: 400
    {
    "errorMessage": "can not find job, jobId is ff808081646e81d40164c5fb414b2b1a1",
    "errorCode": "GES.8301"
    }

返回值

  • 正常

    200

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

    返回值

    说明

    400 Bad Request

    请求错误。

    401 Unauthorized

    鉴权失败。

    403 Forbidden

    没有操作权限。

    404 Not Found

    找不到资源。

    500 Internal Server Error

    服务内部错误。

    503 Service Unavailable

    服务不可用。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问