数据湖探索 DLI-查询所有作业:URI

时间:2024-09-27 11:19:12

URI

  • URI格式:

    GET /v1.0/{project_id}/jobs

  • 参数说明
    表1 URI 参数

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

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

    表2 query参数

    参数名称

    是否必选

    参数类型

    说明

    page-size

    Integer

    每页显示的最大作业个数,范围: [1, 100]。默认值:50。

    current-page

    Integer

    当前页码,默认为第一页。

    start

    Long

    用于查询开始时间在该时间点之后的作业。时间格式为unix时间戳,单位:毫秒。

    end

    Long

    用于查询开始时间在该时间点之前的作业。时间格式为unix时间戳,单位:毫秒。

    job-type

    String

    指定查询的作业类型,包含DDL、DCL、IMPORT、EXPORT、QUERY、INSERT、DATA_MIGRATION、UPDATE、DELETE、RESTART_QUEUE、SCALE_QUEUE,若要查询所有类型的作业,则传入ALL。

    job-status

    String

    指定查询的作业状态。

    job-id

    String

    指定查询的作业ID。可通过提交SQL作业(推荐)获取。

    queue_name

    String

    指定queue_name作为作业过滤条件,查询在指定queue上运行的作业。

    sql_pattern

    String

    指定sql片段作为作业过滤条件,不区分大小写。

    order

    String

    指定作业排序方式,默认为start_time_desc(作业提交时间降序),支持duration_desc(作业运行时长降序)、duration_asc(作业运行时长升序)、start_time_desc(作业提交时间降序)、start_time_asc(作业提交时间升序)四种排序方式。

    engine-type

    String

    引擎类型。

    owner

    String

    提交作业的用户。

    tags

    String

    指定作业标签作为过滤条件,支持多标签过滤,格式为“key=value”。

    • 单标签场景:

    例如,GET /v1.0/{project_id}/jobs?tags=k1%3Dv1

    其中,“=”需要转义为“%3D”,“k1”为标签键,“v1”为标签值。

    • 多标签场景:

    如果涉及到多个标签的场景,则多个标签之间需要通过“,”号分隔,“,”号需要转义为“%2C”,例如:GET /v1.0/{project_id}/jobs?tags=k1%3Dv1%2Ck2%3Dv2

    其中,“=”需要转义为“%3D”,“k1”为标签键1,“v1”为标签值1,“k2”为标签键2,“v2”为标签值2。

    注意:当前只支持所有tags值整体的模糊查询,不支持精确查询。

    带入query参数的URL示例如下:

    GET /v1.0/{project_id}/jobs?page-size={size}&current-page={page_number}&start={start_time}&end={end_time}&job-type={QUERY}&queue_name={test}&order={duration_desc}

support.huaweicloud.com/api-dli/dli_02_0025.html