文档首页/ 弹性公网IP EIP/ API参考/ GEIP API/ 配额/ 查询Job列表
更新时间：2025-02-07 GMT+08:00
查看PDF
分享

查询Job列表

功能介绍

查询Job列表

调试

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

URI

GET /v3/{domain_id}/geip/jobs

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

是

String

最小长度：5

最大长度：32
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

每页条数

最小值：0

最大值：2000

offset

否

Integer

分页查询起始的资源序号

marker

否

String

  • 功能说明：上一页最后一条记录的ID

  • 使用说明：

    • 必须与limit一起使用

    • 输入的值必须为有效的ID值

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指定的字段排序

sort_dir

否

Array of strings

  • 功能说明：排序方向

  • 取值范围：asc（升序）、desc（降序）

id

否

Array of strings

根据ID过滤，支持多值查询，查询条件格式：id=xxx&id=xxx。

action

否

Array of strings

根据action过滤

status

否

Array of strings

根据job状态过滤

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户的Token，如何获取用户Token请参见获取用户Token

响应参数

状态码： 200

表4 响应Header参数

参数

参数类型

描述

X-Request-Id

String

本次请求编号
表5 响应Body参数

参数

参数类型

描述

request_id

String

本次请求的编号

jobs

Array of ListJobs objects

响应job对象

page_info

page_info object

分页页码信息
表6 ListJobs

参数

参数类型

描述

id

String

job的唯一标识

action

String

处理规则

status

String

状态

error_task

String

失败的任务信息

error_code

String

错误码

error_message

String

错误信息

encoded_authorization_message

String

OpenAPI 无权限时，编码 (加密) 后的详细拒绝原因

start_time

String

起始时间

end_time

String

结束时间
表7 page_info

参数

参数类型

描述

next_marker

String

翻页时，作为后一页的marker取值

previous_marker

String

翻页时，作为前一页的marker取值

current_count

Integer

当前页的数据总数

请求示例

查询Job列表

GET https://{Endpoint}/v3/{domain_id}/geip/jobs

响应示例

状态码： 200

OK

{
  "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

错误码

请参见错误码。

父主题： 配额

相关文档