更新时间:2022-04-16 GMT+08:00
分享

查询作业列表

功能介绍

查询当前用户的作业列表,可以根据作业ID作为ID,查询大于ID或小于ID的限定条数的作业,默认查询全部状态的作业,也可以设定运行中或其他状态条件。

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式

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

  • 参数说明
    表1 URI参数说明

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

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

    表2 query参数说明

    参数名称

    是否必选

    参数类型

    说明

    job_type

    String

    作业类型:

    • flink_sql_job:flink sql作业
    • flink_opensource_sql_job:flink opensource sql作业
    • flink_sql_edge_job:flink sql边缘作业
    • flink_jar_job:flink自定义作业

    status

    String

    作业状态码。

    作业的状态如下:

    • job_init:草稿
    • job_submitting:提交中
    • job_submit_fail:提交失败
    • job_running:运行中(开始计费,提交作业后,返回正常结果)
    • job_running_exception:运行异常(停止计费。作业发生运行时异常,停止运行作业)
    • job_downloading:下载中
    • job_idle:空闲
    • job_canceling:停止中
    • job_cancel_success:已停止
    • job_cancel_fail:停止失败
    • job_savepointing:保存点创建中
    • job_arrearage_stopped:因欠费被停止(结束计费。用户账户欠费,作业停止)
    • job_arrearage_recovering:欠费作业恢复中(用户账户欠费,账户充值,作业恢复中)
    • job_finish:已完成

    queue_name

    String

    队列名称。

    order

    String

    查询结果排序。

    • asc:按照时间顺序升序排列
    • desc:按照时间顺序降序排列

    默认为“desc”

    limit

    Integer

    返回的数据条数。默认为“10”,最大值为“100”

    name

    String

    作业名称。长度限制:0-57个字符。

    offset

    Integer

    作业偏移量。

    root_job_id

    Integer

    边缘父作业ID, 用于查询指定边缘作业的子作业。不使用该参数时, 查询所有非边缘作业和边缘父作业, 不包括边缘子作业。

    show_detail

    Boolean

    是否返回作业详情信息。默认为“false”。为“true”时,返回作业详情。具体可见查询作业详情

    user_name

    String

    用户名,可作为筛选条件。

    tags

    String

    指定标签过滤。

    sys_enterprise_project_name

    String

    企业项目名称。

请求消息

无请求参数。

响应消息

表3 响应参数说明

参数名称

是否必选

参数类型

说明

is_success

Boolean

执行请求是否成功。“true”表示请求执行成功。

message

String

系统提示信息,执行成功时,信息可能为空。

job_list

Object

作业列表信息。请参见表4

表4 Job_list参数说明

参数名称

是否必选

参数类型

说明

total_count

Integer

作业查询结果条数。

jobs

Array of Objects

作业信息。请参见表5

表5 Jobs参数说明

参数名称

是否必选

参数类型

说明

job_id

Long

作业ID。

name

String

作业名称。长度限制:0-57个字符。

desc

String

作业描述。长度限制:0-512个字符。

username

String

用户名,当“show_detail”“false”时独有。

job_type

String

作业类型。

  • flink_sql_job:flink sql作业
  • flink_opensource_sql_job:flink opensource sql作业
  • flink_sql_edge_job:flink sql边缘作业
  • flink_jar_job:flink自定义作业

status

String

作业状态。

status_desc

String

作业状态描述。

create_time

Long

作业创建时间。

start_time

Long

作业启动时间。“0”表示尚未启动。

duration

Long

作业运行时长。 单位ms,“show_detail”“false”时独有。

root_id

Long

父作业ID。“show_detail”“false”时独有。

graph_editor_enabled

Boolean

作业的流图是否可编辑。“true”表示作业的流图可以编辑,“false”表示作业的流图不可以编辑。

has_savepoint

Boolean

作业是否有保存点。“true”表示作业有保存点,“false”表示作业没有保存点。

user_id

String

作业所属用户标识。 “show_detail”“true”时独有。

project_id

String

作业所属项目标识。 “show_detail”“true”时独有。

sql_body

String

Stream SQL语句。 “”“show_detail”“false”时独有。

run_mode

String

作业运行模式。包括共享、独享模式和边缘节点。“show_detail”“true”时独有。

  • shared_cluster:共享
  • exclusive_cluster:独享
  • edge_node:边缘节点

job_config

Object

作业配置。 “show_detail”“false”时独有。具体参数说明请参见表6

main_class

String

jar包主类。“show_detail”“false”时独有。

entrypoint_args

String

jar包作业运行参数。多个参数之间用空格分隔。“show_detail”“true”时独有。

execution_graph

String

作业执行计划。“show_detail”“false”时独有。

update_time

Long

作业更新时间。“show_detail”“false”时独有。

表6 job_config参数说明

参数名称

是否必选

参数类型

说明

checkpoint_enabled

Boolean

是否开启作业自动快照功能。

  • true:开启
  • false:关闭

默认为“false”

checkpoint_mode

String

快照模式,。两种可选:

  • exactly_once:数据只被消费一次。
  • at_least_once:数据至少被消费一次。

默认值为“exactly_once”

checkpoint_interval

Integer

快照时间间隔。 单位为秒,默认值为“10”

log_enabled

Boolean

是否启用日志存储。默认为“false”

obs_bucket

String

OBS桶名。

smn_topic

String

SMN主题名。当作业异常时,向该SMN主题推送告警信息。

root_id

Integer

父作业ID。

edge_group_ids

Array of Strings

边缘计算组ID列表。多个ID以逗号分隔。

manager_cu_number

Integer

管理单元CU数。默认为“1”

cu_number

Integer

用户为作业选择的CU数量。 “show_detail”“true”时独有。

  • 最小值:2
  • 最大值:400

默认为“2”

parallel_number

Integer

用户设置的作业并行数。 “show_detail”“true”时独有。

  • 最小值:1
  • 最大值:2000

默认为“1”

restart_when_exception

Boolean

是否开启异常重启功能。

idle_state_retention

Integer

空闲状态过期周期。

udf_jar_url

String

用户已上传到DLI资源管理系统的程序包名,用户sql作业的udf jar通过该参数传入。

dirty_data_strategy

String

作业脏数据策略。

  • “2:obsDir”:保存,obsDir表示脏数据存储路径。
  • “1”:抛出异常。
  • “0”:忽略。

entrypoint

String

用户已上传到DLI资源管理系统的程序包名,用户自定义作业主类所在的jar包。

dependency_jars

Array of Strings

用户已上传到DLI资源管理系统的程序包名,用户自定义作业的其他依赖包。

dependency_files

Array of Strings

用户已上传到DLI资源管理系统的资源包名,用户自定义作业的依赖文件。

executor_number

Integer

作业使用计算节点个数。

executor_cu_number

Integer

计算节点cu数。

resume_checkpoint

Boolean

异常自动重启时,是否从最新checkpoint恢复。默认值为“false”。

示例

  • 请求样例
    None
  • 响应样例
    {
        "is_success": "true",
        "message": "作业列表查询成功",
        "job_list": {
            "total_count": 26,
            "jobs": [
                {
                    "job_id": 146,
                    "name": "aaaaa",
                    "desc": "",
                    "user_name": "",
                    "job_type": "flink_sql_job",
                    "status": "job_init",
                    "status_desc": "",
                    "create_time": 1578892414688,
                    "duration": 0,
                    "root_id": -1,
                    "graph_editor_enabled": false,
                    "has_savepoint": false
                }
            ]
        }
    }

状态码

状态码如表7所示。

表7 状态码

状态码

描述

200

查询作业列表成功。

400

输入参数无效。

错误码

调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码

分享:

    相关文档

    相关产品

close