# 查询Job列表 - ListJobs #### 功能介绍 查询Job列表。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GEIP/doc?api=ListJobs)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-eip/eip_apipermission_0000.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v3/{domain_id}/geip/jobs 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | domain_id | 是 | String | **参数解释：** 租户账号ID，获取租户账号ID请参见[租户账号ID](https://support.huaweicloud.com/api-iam/iam_17_0002.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 最小长度：**5** 最大长度：**32** | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | **参数解释：** 每页条数。 **约束限制：** 不涉及。 **取值范围：** 0-2000 **默认取值：** 不涉及。 最小值：**0** 最大值：**2000** | | offset | 否 | Integer | **参数解释：** 分页查询起始的资源序号。 **约束限制：** 不涉及。 **取值范围：** 0-2000 **默认取值：** 不涉及。 | | marker | 否 | String | **参数解释：** 上一页最后一条记录的ID。 **约束限制：** - 必须与limit一起使用。 - 输入的值必须为有效的ID值。 **取值范围：** 格式：\[a-fA-F0-9\]{8}-\[a-fA-F0-9\]{4}-\[a-fA-F0-9\]{4}-\[a-fA-F0-9\]{4}-\[a-fA-F0-9\]{12} **默认取值：** 不涉及。 | | page_reverse | 否 | Boolean | **参数解释：** 翻页方向。 **约束限制：** 不涉及。 **取值范围：** - true：查询上一页。 - false：查询下一页。 **默认取值：** 不涉及。 | | fields | 否 | Array of strings | **参数解释：** 查询指定的字段。 **约束限制：** 格式为fields=A\&fields=B\&fields=C\&...... **取值范围：** 支持的字段： - id - action - status - error_task - error_code - error_message - start_time - end_time **默认取值：** 不涉及。 | | sort_key | 否 | Array of strings | **参数解释：** 按照sort_key指定的字段排序。 **约束限制：** 不涉及。 **取值范围：** - id - start_time - end_time **默认取值：** 不涉及。 | | sort_dir | 否 | Array of strings | **参数解释：** 排序方向。 **约束限制：** 不涉及。 **取值范围：** - asc：升序 - desc：降序 **默认取值：** 不涉及。 | | id | 否 | Array of strings | **参数解释：** 根据ID过滤，支持多值查询。 **约束限制：** 查询条件格式：id=xxx\&id=xxx。 **取值范围：** 格式：\[a-fA-F0-9\]{8}-\[a-fA-F0-9\]{4}-\[a-fA-F0-9\]{4}-\[a-fA-F0-9\]{4}-\[a-fA-F0-9\]{12} **默认取值：** 不涉及。 | | action | 否 | Array of strings | **参数解释：** 根据action过滤。 **约束限制：** 不涉及。 **取值范围：** - CreateGEIPGraph - UpdateGEIPGraph - BindGEIPGraph - UnBindGEIPGraph - BatchAttachBandwidthGraph - BatchDetachBandwidthGraph - CreateGeipSegmentGraph - BindGeipSegmentGraph **默认取值：** 不涉及。 | | status | 否 | Array of strings | **参数解释：** 根据job状态过滤。 **约束限制：** 不涉及。 **取值范围：** - FINISH_SUCC - FINISH_ROLLBACK_SUCC **默认取值：** 不涉及。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户的Token，如何获取用户Token请参见[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html#iam_30_0001__li195948474711)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表4响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-Request-Id | String | 本次请求编号 | 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | **参数解释：** 请求ID。 **取值范围：** 不涉及。 | | jobs | Array of [ListJobs] objects | **参数解释：** 响应job对象。 **取值范围：** 不涉及。 | | page_info | [page_info] object | **参数解释：** 分页页码信息。 **取值范围：** 不涉及。 | 表6ListJobs | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** job的唯一标识。 **取值范围：** 不涉及。 | | action | String | **参数解释：** 处理规则。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 状态。 **取值范围：** 不涉及。 | | error_task | String | **参数解释：** 失败的任务信息。 **取值范围：** 不涉及。 | | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_message | String | **参数解释：** 错误信息。 **取值范围：** 不涉及。 | | encoded_authorization_message | String | **参数解释：** OpenAPI 无权限时，编码 (加密) 后的详细拒绝原因。 **取值范围：** 不涉及。 | | start_time | String | **参数解释：** 起始时间。 **取值范围：** 格式：yyyy-MM-dd'T'HH:mm:ss'Z' | | end_time | String | **参数解释：** 结束时间。 **取值范围：** 格式：yyyy-MM-dd'T'HH:mm:ss'Z' | 表7page_info | 参数 | 参数类型 | 描述 | |:---|:---|:---| | next_marker | String | **参数解释：** 翻页时，作为后一页的marker取值。 **取值范围：** 不涉及。 | | previous_marker | String | **参数解释：** 翻页时，作为前一页的marker取值。 **取值范围：** 不涉及。 | | current_count | Integer | **参数解释：** 当前页的数据总数。 **取值范围：** 不涉及。 | #### 请求示例 查询Job列表 ``` GET https://{Endpoint}/v3/{domain_id}/geip/jobs ``` #### 响应示例 **状态码：200** ``` { "request_id" : "ce9c7dfb77ee01f7987a86030650be4f", "jobs" : [ { "status" : "FINISH_SUCC", "id" : "1318b3c3-75a1-46e7-845f-0562d07de7e0", "action" : "CreateGEIPGraph", "error_task" : null, "error_code" : null, "error_message" : null, "start_time" : "2023-12-12T07:37:36Z", "end_time" : "2023-12-12T07:37:36Z" }, { "status" : "FINISH_SUCC", "id" : "1cb1a0a8-3647-43a1-9b0c-1105539f35d2", "action" : "CreateGEIPGraph", "error_task" : null, "error_code" : null, "error_message" : null, "start_time" : "2023-12-12T07:34:44Z", "end_time" : "2023-12-12T07:34:44Z" } ], "page_info" : { "previous_marker" : "1318b3c3-75a1-46e7-845f-0562d07de7e0", "current_count" : 2 } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-eip/ErrorCode.html)。