# 查询任务中心(1.1.8) -ListJobs2 #### 功能介绍 查询管理面任务中心。当前创建图、关闭图、启动图、删除图、增加备份、导入图、导出图、升级图等操作为异步任务，该API用于查询这些任务的详情。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GES&api=ListJobs2&version=v2)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### URI GET /v2/{project_id}/graphs/jobs 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目编号。获取方法，请参见[获取项目ID](https://support.huaweicloud.com/api-ges/ges_03_0111.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母和数字组成，且长度为\[1-64\]个字符。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | end_time | 否 | String | **参数解释：** 任务结束日期，当前只支持日期，不支持时间。格式为：yyyy-MM-dd，比如2019-03-27。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | graph_name | 否 | String | **参数解释：** 关联的图名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | limit | 否 | Integer | **参数解释：** 每页资源数量的最大值，默认为10。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | offset | 否 | Integer | **参数解释：** 本次请求的起始位置，默认为0。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | start_time | 否 | String | **参数解释：** 任务开始日期，当前只支持日期，不支持时间。格式为：yyyy-MM-dd，比如2019-03-27。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母和数字组成，且长度为\[1-64\]个字符。 **默认取值：** 不涉及。 | | status | 否 | String | **参数解释：** 任务状态。 **约束限制：** 不涉及。 **取值范围：** - running。 - waiting。 - success。 - partiallyFailed。 - failed。 **默认取值：** 不涉及。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。用于获取操作API的权限。获取方法请参见[获取Token接口](https://support.huaweicloud.com/api-ges/ges_03_0005.html)，响应消息头中X-Subject-Token的值即为Token。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码： 200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | job_count | Integer | **参数解释**： 任务总数。 **取值范围**： 不涉及。 | | job_list | Array of [job_list] objects | **参数解释**： 任务列表。 **取值范围**： 不涉及 | 表5job_list | 参数 | 参数类型 | 描述 | |:---|:---|:---| | job_id | String | **参数解释**： 任务ID。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 任务状态。 **取值范围**： - pending：等待中。 - running：运行中。 - success：成功。 - partiallyFailed：部分成功。 - failed：失败。 | | job_type | String | **参数解释**： 任务类型。 **取值范围**： 不涉及。 | | job_name | String | **参数解释**： 任务名称。 **取值范围**： 不涉及。 | | related_graph | String | **参数解释**： 关联图名称。 **取值范围**： 不涉及。 | | begin_time | String | **参数解释**： 任务开始时间，格式为UTC,"yyyy-MM-dd'T'HH:mm:ss"。 **取值范围**： 不涉及。 | | end_time | String | **参数解释**： 任务结束时间，格式为UTC,"yyyy-MM-dd'T'HH:mm:ss"。 **取值范围**： 不涉及。 | | job_detail | [job_detail] object | **参数解释**： 只有job_name为ImportGraph时才返回，用于显示导入图详情。 **取值范围**： 不涉及。 | | fail_reason | String | **参数解释**： 任务失败原因。 **取值范围**： 不涉及。 | | job_progress | Double | **参数解释**： 任务执行进度，预留字段，暂未使用。 **取值范围**： 不涉及。 | 表6job_detail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | schema_path | Array of [schema_path] objects | **参数解释**： 元数据路径。 **取值范围**： 不涉及。 | | edgeset_path | Array of [edgeset_path] objects | **参数解释**： 边数据集路径。 **取值范围**： 不涉及。 | | vertexset_path | Array of [vertexset_path] objects | **参数解释**： 点数据集路径。 **取值范围**： 不涉及。 | 表7schema_path | 参数 | 参数类型 | 描述 | |:---|:---|:---| | path | String | **参数解释**： OBS文件路径。 **取值范围**： 不涉及。 | | log | String | **参数解释**： OBS文件导入的日志存储文件。 **取值范围**： 不涉及。 | | status | String | **参数解释**： OBS文件导入状态。 **取值范围**： - success：完全成功。 - failed：完全失败。 - partFailed：部分成功。 | | cause | String | **参数解释**： 导入失败原因。 **取值范围**： 不涉及。 | | total_lines | Long | **参数解释**： 导入总行数。其值为-1时表示当前版本没有返回该字段。 **取值范围**： 不涉及。 | | failed_lines | Long | **参数解释**： 导入失败行数。其值为-1时表示当前版本没有返回该字段。 **取值范围**： 不涉及。 | | successful_lines | Long | **参数解释**： 导入成功行数。其值为-1时表示当前版本没有返回该字段。 **取值范围**： 不涉及。 | 表8edgeset_path | 参数 | 参数类型 | 描述 | |:---|:---|:---| | path | String | **参数解释**： OBS文件路径。 **取值范围**： 不涉及。 | | log | String | **参数解释**： OBS文件导入的日志存储文件。 **取值范围**： 不涉及。 | | status | String | **参数解释**： OBS文件导入状态。 **取值范围**： - success：完全成功。 - failed：完全失败。 - partFailed：部分成功。 | | cause | String | **参数解释**： 导入失败原因。 **取值范围**： 不涉及。 | | total_lines | Long | **参数解释**： 导入总行数。其值为-1时表示当前版本没有返回该字段。 **取值范围**： 不涉及。 | | failed_lines | Long | **参数解释**： 导入失败行数。其值为-1时表示当前版本没有返回该字段。 **取值范围**： 不涉及。 | | successful_lines | Long | **参数解释**： 导入成功行数。其值为-1时表示当前版本没有返回该字段。 **取值范围**： 不涉及。 | 表9vertexset_path | 参数 | 参数类型 | 描述 | |:---|:---|:---| | path | String | **参数解释**： OBS文件路径。 **取值范围**： 不涉及。 | | log | String | **参数解释**： OBS文件导入的日志存储文件。 **取值范围**： 不涉及。 | | status | String | **参数解释**： OBS文件导入状态。 **取值范围**： - success：完全成功。 - failed：完全失败。 - partFailed：部分成功。 | | cause | String | **参数解释**： 导入失败原因。 **取值范围**： 不涉及。 | | total_lines | Long | **参数解释**： 导入总行数。其值为-1时表示当前版本没有返回该字段。 **取值范围**： 不涉及。 | | failed_lines | Long | **参数解释**： 导入失败行数。其值为-1时表示当前版本没有返回该字段。 **取值范围**： 不涉及。 | | successful_lines | Long | **参数解释**： 导入成功行数。其值为-1时表示当前版本没有返回该字段。 **取值范围**： 不涉及。 | **状态码： 400** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 系统提示信息。 - 执行成功时，字段可能为空。 - 执行失败时，用于显示错误码。 **取值范围**： 不涉及。 | | error_msg | String | **参数解释**： 系统提示信息。 - 执行成功时，字段可能为空。 - 执行失败时，用于显示错误信息。 **取值范围**： 不涉及。 | #### 请求示例 查询管理面任务中心。 ``` GET https://{Endpoint}/v2/{project_id}/graphs/jobs?offset=0&limit=100 ``` #### 响应示例 **状态码： 200** 成功响应示例 ``` { "job_count" : 2, "job_list" : [ { "job_id" : "ff80808167bb90340167bc3c7b5b026a", "status" : "success", "job_type" : "GraphManagement", "job_name" : "ImportGraph", "related_graph" : "test1217", "begin_time" : "2018-12-17T12:55:40", "end_time" : "2018-12-17T12:56:32", "job_detail" : { "vertexset_path" : null, "edgeset_path" : [ { "path" : "hkmovie/edge.csv", "log" : null, "cause" : null, "status" : "success" } ], "schema_path" : [ { "path" : "hkmovie/schema.xml", "log" : null, "cause" : null, "status" : "success" } ] }, "job_progress" : 0 }, { "job_id" : "ff80808167bb90340167bc5d0b1d0358", "status" : "success", "job_type" : "GraphManagement", "job_name" : "DeleteGraph", "related_graph" : "test1218", "begin_time" : "2018-12-17T13:31:14", "end_time" : "2018-12-17T13:34:48", "job_progress" : 0 } ] } ``` **状态码： 400** 失败响应示例 ``` { "error_msg" : "failed", "error_code" : "GES.9999" } ``` #### 状态码 | 返回值 | 说明 | |:---|:---| | 400 Bad Request | 请求错误 | | 401 Unauthorized | 鉴权失败 | | 403 Forbidden | 没有操作权限 | | 404 Not Found | 找不到资源 | | 500 Internal Server Error | 服务内部错误 | | 503 Service Unavailable | 服务不可用 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-ges/ges_03_0040.html)。