文档首页 > > API参考> 管理面API> 任务中心API> 查询任务中心(1.1.8)

查询任务中心(1.1.8)

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

功能介绍

查询管理面任务中心。当前创建图、关闭图、启动图、删除图、增加备份、导入图、导出图、升级图等操作为异步任务,该API用于查询这些任务的详情。

URI

  • URI 格式
    GET /v1.0/{projectId}/graphs/jobs?offset={offset}&limit={limit}&status={status}&graphName={graphName}&startTime={startTime}&endTime={endTime}
  • 参数说明
    表1 URI参数说明

    参数

    是否必选

    类型

    说明

    projectId

    String

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

    offset

    Integer

    本次请求的起始位置,默认为0。

    limit

    Integer

    每页资源数量的最大值,默认为10。

    status

    String

    任务状态。取值为:

    • running
    • waiting
    • success
    • failed

    graphName

    String

    关联的图名称

    startTime

    String

    任务开始日期,当前只支持日期,不支持时间。格式为:yyyy-MM-dd,比如2019-03-27。

    endTime

    String

    任务结束日期,当前只支持日期,不支持时间。格式为:yyyy-MM-dd,比如2019-03-27。

请求

  • 请求样例
    GET    https://Endpoint/v1.0/{projectId}/graphs/jobs?offset=0&limit=100

响应

  • 要素说明
    表2 要素说明

    参数

    是否必选

    类型

    说明

    errorMessage

    String

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

    errorCode

    String

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

    jobCount

    Integer

    任务总数

    jobList

    JsonArray

    任务列表。其内容参考表3 job属性列表

  • 请求成功样例
    Http Status Code: 200
    {  
    "jobCount": 136,
    "jobList": [
     {
          "jobId": "ff80808167bb90340167bc3c7b5b026a",
          "status": "success",
          "jobType": "GraphManagement",
          "jobName": "ImportGraph",
          "relatedGraph": "test1217",
          "beginTime": "2018-12-17T12:55:40",
          "endTime": "2018-12-17T12:56:32",
          "jobDetail": {
            "vertexsetPath": null,
            "edgesetPath": [
              {
                "path": "hkmovie/edge.csv",
                "log": null,
                "cause": null,
                "status": "success"
              }
            ],
            "schemaPath": [
              {
                "path": "hkmovie/schema.xml",
                "log": null,
                "cause": null,
                "status": "success"
              }
            ]
          },
          "jobProgress": 0
        },
        {
          "jobId": "ff80808167bb90340167bc5d0b1d0358",
          "status": "success",
          "jobType": "GraphManagement",
          "jobName": "DeleteGraph",
          "relatedGraph": "test1218",
          "beginTime": "2018-12-17T13:31:14",
          "endTime": "2018-12-17T13:34:48",
          "jobProgress": 0
        }
    ]
    }
  • 请求失败样例
    Http Status Code: 400
    {
    "errorMessage": "failed",
    "errorCode": "GES.9999"
    }

返回值

  • 正常

    200

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

    返回值

    说明

    400 Bad Request

    请求错误。

    401 Unauthorized

    鉴权失败。

    403 Forbidden

    没有操作权限。

    404 Not Found

    找不到资源。

    500 Internal Server Error

    服务内部错误。

    503 Service Unavailable

    服务不可用。

分享:

    相关文档

    相关产品

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

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

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

字符长度不能超过200

提交反馈 取消

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

智能客服提问云社区提问