本文导读

展开导读

文档首页/ 图引擎服务 GES/ API参考/ 历史API/ 管理面API（V1）/ 任务中心API/ 查询任务中心(1.1.8)

查询任务中心(1.1.8)

更新时间：2024-07-26 GMT+08:00

查看PDF

功能介绍

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

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1.0/{project_id}/graphs/jobs

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。获取方法请参见获取项目ID。

表2 Query参数
参数	是否必选	参数类型	描述
endTime	否	String	任务结束日期，当前只支持日期，不支持时间。格式为：yyyy-MM-dd，比如2019-03-27。
graph_name	否	String	关联的图名称
limit	否	String	每页资源数量的最大值，默认为10。
offset	否	String	本次请求的起始位置，默认为0。
startTime	否	String	任务开始日期，当前只支持日期，不支持时间。格式为：yyyy-MM-dd，比如2019-03-27。
status	否	String	任务状态。取值为： running waiting success failed

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。用于获取操作API的权限。获取方法请参见获取Token接口，响应消息头中X-Subject-Token的值即为Token。

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
errorMessage	String	系统提示信息。执行成功时，字段可能为空。执行失败时，用于显示错误信息。
errorCode	String	系统提示信息。执行成功时，字段可能为空。执行失败时，用于显示错误码。
jobCount	Integer	任务总数。
jobList	Array of Job objects	任务列表。

表5 Job
参数	参数类型	描述
jobId	String	任务ID。
status	String	任务状态。 pending：等待中。 running：运行中。 success：成功。 failed：失败。
jobType	String	任务类型。
jobName	String	任务名称。
relatedGraph	String	关联图名称。
beginTime	String	任务开始时间，格式为UTC,"yyyy-MM-dd'T'HH:mm:ss"。
endTime	String	任务结束时间，格式为UTC,"yyyy-MM-dd'T'HH:mm:ss"。
jobDetail	JobDetail object	只有jobName为ImportGraph时才返回，用于显示导入图详情。
failReason	String	任务失败原因。
jobProgress	Double	任务执行进度，预留字段，暂未使用。

表6 JobDetail
参数	参数类型	描述
schemaPath	Array of schemaPath objects	元数据路径。
edgesetPath	Array of edgesetPath objects	边数据集路径。
vertexsetPath	Array of vertexsetPath objects	点数据集路径。

表7 schemaPath
参数	参数类型	描述
path	String	OBS文件路径。
log	String	OBS文件导入日志存储文件。
status	String	OBS文件导入状态。 success：完全成功 failed：完全失败 partFailed：部分成功
cause	String	导入失败原因

表8 edgesetPath
参数	参数类型	描述
path	String	OBS文件路径。
log	String	OBS文件导入日志存储文件。
status	String	OBS文件导入状态。 success：完全成功 failed：完全失败 partFailed：部分成功
cause	String	导入失败原因。
totalLines	Long	导入总行数。其值为-1时表示当前版本没有返回该字段。
failedLines	Long	导入失败行数。其值为-1时表示当前版本没有返回该字段。
successfulLines	Long	导出成功行数。其值为-1时表示当前版本没有返回该字段。

表9 vertexsetPath
参数	参数类型	描述
path	String	OBS文件路径。
log	String	OBS文件导入日志存储文件。
status	String	OBS文件导入状态。 success：完全成功 failed：完全失败 partFailed：部分成功
cause	String	导入失败原因。
totalLines	Long	导入总行数。其值为-1时表示当前版本没有返回该字段。
failedLines	Long	导入失败行数。其值为-1时表示当前版本没有返回该字段。
successfulLines	Long	导出成功行数。其值为-1时表示当前版本没有返回该字段。

请求示例

GET    https://Endpoint/v1.0/{project_id}/graphs/jobs?offset=0&limit=100

响应示例

状态码： 200

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
    }
]
}

状态码： 400

Bad Request

{
  "errorMessage" : "failed",
  "errorCode" : "GES.9999"
}

状态码

状态码	说明
200	请求成功。
400	请求错误。
401	鉴权失败。
403	没有操作权限。
404	找不到资源。
500	服务内部错误。
503	服务不可用。

父主题： 任务中心API

上一篇：查询Job状态(1.0.0)-管理面

下一篇：业务面API

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

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

智能客服提问云社区提问

查询任务中心(1.1.8)

功能介绍

调试

URI

请求参数

响应参数

请求示例

响应示例

状态码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线

文档反馈