文档首页 > > API参考> 业务面API> Job管理API>

查询Job状态(1.0.0)-业务面

查询Job状态(1.0.0)-业务面

分享
更新时间:2021/05/08 GMT+08:00

功能介绍

查询Job的执行状态。对点过滤查询、边过滤查询、执行算法等异步API,命令下发后,会返回jobId,通过jobId查询任务的执行状态。

URI

  • URI 格式
    GET /ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id}/status?offset=offset&limit=limit
  • 参数说明
    表1 URI参数说明

    参数

    是否必选

    类型

    说明

    project_id

    String

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

    job_id

    String

    Job ID。

    offset

    Integer

    本次查询偏移量,默认为0。

    limit

    Integer

    本次查询返回最大数量(最大100000),默认为100000。

请求

  • 请求样例
    GET http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id}/status?offset=0&limit=2

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

响应

  • 要素说明
    表2 要素说明

    参数

    是否必选

    类型

    说明

    errorMessage

    String

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

    errorCode

    String

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

    status

    String

    查询成功时返回任务状态,包括以下四种状态:

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

    查询失败时字段为空。

    data

    Json

    算法运行的结果。查询失败时字段为空。

  • 参数说明
    表3 data参数说明

    参数

    是否必选

    类型

    说明

    vertices

    List

    点上关联的算法结果。

    edges

    List

    边上关联的算法结果。

    outputs

    Json

    其他输出结果。

    data_return_size

    Integer

    本次查询返回结果数量。

    data_offset

    Integer

    本次查询返回结果偏移量。

    data_total_size

    Integer

    异步任务产生的结果数据总量。

  • 请求成功样例
    Http Status Code: 200
    {
        "data": {
            "outputs": {
                "data_return_size": 2,
                "vertices": [
                    {
                        "id": "Sarah",
                        "label": "user",
                        "properties": {
                            "Occupation": [
                                "other or not specified"
                            ],
                            "ChineseName": [
                                "莎拉"
                            ],
                            "Zip-code": [
                                "55105"
                            ],
                            "Gender": [
                                "F"
                            ],
                            "Age": [
                                "18-24"
                            ]
                        }
                    },
                    {
                        "id": "Sidney",
                        "label": "user",
                        "properties": {
                            "Occupation": [
                                "writer"
                            ],
                            "ChineseName": [
                                "西德尼"
                            ],
                            "Zip-code": [
                                "85296"
                            ],
                            "Gender": [
                                "M"
                            ],
                            "Age": [
                                "18-24"
                            ]
                        }
                    }
                ],
                "data_offset": 0,
                "data_total_size": 19
             }
        },
        "status": "success"
    }       
  • 请求失败样例
    Http Status Code: 400
    {
      "errorMessage": "can not find job, jobId is  9440a7ebXXXXXXXXXXXXXXXXXXXX2d079a67001679122",
      "errorCode": "GES.8301"
    }

返回值

  • 正常

    200

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

    返回值

    说明

    400 Bad Request

    请求错误。

    401 Unauthorized

    鉴权失败。

    403 Forbidden

    没有操作权限。

    404 Not Found

    找不到资源。

    500 Internal Server Error

    服务内部错误。

    503 Service Unavailable

    服务不可用。

分享:

    相关文档

    相关产品

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

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

*必选

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

字符长度不能超过200

提交反馈 取消

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

智能客服提问云社区提问