# 查询作业列表 - ListFlinkJobs #### 功能介绍 查询当前用户的作业列表，可以根据作业ID作为ID，查询大于ID或小于ID的限定条数的作业，默认查询全部状态的作业，也可以设定运行中或其他状态条件。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=DLI&api=ListFlinkJobs)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限及授权项说明](https://support.huaweicloud.com/api-dli/dli_02_0375.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 Action | 访问级别 Access Level | 资源类型（\*为必须） Resource Type (\*: required) | 条件键 Condition Key | 别名 Alias | 依赖的授权项 Dependencies | |:---|:---|:---|:---|:---|:---| | dli:jobs:list | list | jobs \* | - | - | - | | dli:jobs:list | list | - | - [g:RequestTag/\](https://support.huaweicloud.com/usermanual-iam5/iam_01_1287.html) - [g:TagKeys](https://support.huaweicloud.com/usermanual-iam5/iam_01_1287.html) | - | - | #### URI - URI格式 GET /v1.0/{project_id}/streaming/jobs - 参数说明 表1URI参数说明 | 参数名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目编号，用于资源隔离。获取方式请参考[获取项目ID](https://support.huaweicloud.com/api-dli/dli_02_0183.html)。 示例: 48cc2c48765f481480c7db940d6409d1 **约束限制：** 无 **取值范围：** 只能由英文字母和数字组成，且长度为\[1-64\]个字符。 **默认取值：** 无 | 表2query参数说明 | 参数名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | 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 | **参数解释：** 返回的数据条数。 **约束限制：** 最大值为"100" **取值范围：** 0-100 **默认取值：** 默认为"10"。 | | name | 否 | String | **参数解释：** 作业名称。 **约束限制：** 长度限制：0-57个字符。 **取值范围：** 无 **默认取值：** 无 | | offset | 否 | Integer | **参数解释：** 作业偏移量。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | show_detail | 否 | Boolean | **参数解释：** 是否返回作业详情信息。默认为"false"。为"true"时，返回作业详情。具体可见[查询作业详情 - ShowFlinkJob](https://support.huaweicloud.com/api-dli/dli_02_0235.html)。 **约束限制：** 无 **取值范围：** 无 **默认取值：** false | | user_name | 否 | String | **参数解释：** 用户名，可作为筛选条件。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | tags | 否 | String | **参数解释：** 指定标签过滤。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | #### 请求消息 无请求参数。 #### 响应消息 表3响应参数说明 | 参数名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | is_success | 否 | String | **参数解释：** 执行请求是否成功。 **取值范围：** "true"：表示请求执行成功。 "false"：表示请求执行失败。 | | message | 否 | String | **参数解释：** 系统提示信息，执行成功时，该值为空。 **取值范围：** 无 | | job_list | 否 | Object | **参数解释：** 作业列表信息。请参见[表4]。 **取值范围：** 无 | 表4job_list参数说明 | 参数名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | total_count | 否 | Integer | **参数解释：** 作业查询结果条数。 **取值范围：** 无 | | jobs | 否 | Array of Objects | **参数解释：** 作业信息。请参见[表5]。 **取值范围：** 无 | 表5Jobs参数说明 | 参数名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | job_id | 否 | Long | **参数解释：** 作业ID。 **取值范围：** 无 | | name | 否 | String | **参数解释：** 作业名称。 **取值范围：** 长度限制：0-57个字符。 | | desc | 否 | String | **参数解释：** 作业描述。 **取值范围：** 长度限制：0-512个字符。 | | user_name | 否 | String | **参数解释：** 用户名，当"show_detail"为"false"时独有。 **取值范围：** 长度在\[1,128\]范围内的字符串 | | 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：已完成 | | status_desc | 否 | String | **参数解释：** 作业状态描述。 **取值范围：** 无 | | create_time | 否 | Long | **参数解释：** 作业创建时间。示例: 1516952770835 **取值范围：** 大于等于0的整数。 | | start_time | 否 | Long | **参数解释：** 作业启动时间。"0"表示尚未启动。 示例: 1516952710740 **取值范围：** 大于等于0的整数。 | | duration | 否 | Long | **参数解释：** 作业运行时长。 单位ms，"show_detail"为"false"时独有。 **取值范围：** 大于等于0的整数。 | | 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"为"true"时独有。 **取值范围：** 无 | | run_mode | 否 | String | **参数解释：** 作业运行模式。包括共享、独享模式和边缘节点。"show_detail"为"true"时独有。 **取值范围：** - shared_cluster：共享 - exclusive_cluster：独享 - edge_node：边缘节点 | | job_config | 否 | Object | **参数解释：** 作业配置。 "show_detail"为"true"时独有。具体参数说明请参见[表6]。 **取值范围：** 无 | | main_class | 否 | String | **参数解释：** jar包主类。"show_detail"为"true"时独有。 **取值范围：** 无 | | entrypoint_args | 否 | String | **参数解释：** jar包作业运行参数。多个参数之间用空格分隔。"show_detail"为"true"时独有。 **取值范围：** 无 | | execution_graph | 否 | String | **参数解释：** 作业执行计划。"show_detail"为"true"时独有。 **取值范围：** 无 | | update_time | 否 | Long | **参数解释：** 作业更新时间。"show_detail"为"true"时独有。 **取值范围：** 无 | | queue_name | 否 | String | **参数解释：** 队列名称。 **取值范围：** 无 | | edge_group_ids | 否 | Array of Strings | **参数解释：** 边缘计算组ID列表。多个ID以逗号分隔。 **取值范围：** 无 | | restart_times | 否 | Integer | **参数解释：** 重启次数。 **取值范围：** 无 | | savepoint_path | 否 | String | **参数解释：** 手动产生的Checkpoint的保存路径。 **取值范围：** 无 | 表6job_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"。 **取值范围：** true：启用日志存储。 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数。 **取值范围：** 无 | | execution_agency_urn | 否 | String | **参数解释：** 参授权给DLI的委托名。 Flink1.15版本时支持配置该参数。 **取值范围：** 无 | | resume_checkpoint | 否 | Boolean | **参数解释：** 异常自动重启时，是否从最新checkpoint恢复。默认值为"false"。 **取值范围：** 无 | | runtime_config | 否 | String | **参数解释：** Flink作业运行时自定义优化参数。 **取值范围：** 无 | | graph_editor_enabled | 否 | Boolean | **参数解释：** 流图编辑开关。默认为"false"。 **取值范围：** 无 | | graph_editor_data | 否 | String | **参数解释：** 流图编辑数据。默认为null。 **取值范围：** 无 | | resume_max_num | 否 | Integer | **参数解释：** 异常重试最大次数。-1代表无限。 **取值范围：** 无 | | checkpoint_path | 否 | String | **参数解释：** 检查点保存路径。 **取值范围：** 无 | | config_url | 否 | String | **参数解释：** 用户上传的config包OBS路径。 **取值范围：** 无 | | tm_cus | 否 | int | **参数解释：** 单TM所占CU数。 **取值范围：** 无 | | tm_slot_num | 否 | int | **参数解释：** 单TM Slot数。 **取值范围：** 无 | | image | 否 | String | **参数解释：** 自定义镜像。格式为：组织名/镜像名:镜像版本。 当用户设置"feature"为"custom"时，该参数生效。用户可通过与"feature"参数配合使用，指定作业运行使用自定义的Flink镜像。关于如何使用自定义镜像，请参考《[数据湖探索用户指南](https://support.huaweicloud.com/usermanual-dli/dli_01_0494.html)》。 **取值范围：** 无 | | feature | 否 | String | **参数解释：** 自定义作业特性。表示用户作业使用的Flink镜像类型。 **取值范围：** - basic：表示使用DLI提供的基础Flink镜像。 - custom：表示使用用户自定义的Flink镜像。 | | flink_version | 否 | String | **参数解释：** Flink版本。当用户设置"feature"为"basic"时，该参数生效。用户可通过与"feature"参数配合使用，指定作业运行使用的DLI基础Flink镜像的版本。 **取值范围：** 无 | | operator_config | 否 | String | **参数解释：** 各算子并行度参数，以json的形式展示各算子id和并行度。 **取值范围：** 无 | | static_estimator_config | 否 | String | **参数解释：** 静态流图资源预估参数，以json的形式展示。 **取值范围：** 无 | | real_cu_number | 否 | Integer | **参数解释：** 实际使用的CU数。默认值为"0"，表示此时以"cu_number"的值为准。 **取值范围：** 无 | | resource_config_version | 否 | String | **参数解释：** 资源配置版本。可选值 "v1" ,"v2".默认为"v1"。 v2版本对比于v1模版不支持设置CU数量，支持直接设置Job Manager Memory和Task Manager Memory。 **取值范围：** v1：适用于Flink 1.12、Flink 1.15 V2：适用于Flink 1.15、Flink 1.17 优先推荐使用V2版本的参数设置。 | | resource_config | 否 | Object | **参数解释：** Flink 作业的资源配置。 **取值范围：** 具体参数说明请参考[表7]。 资源配置版本 为 "v2"时，配置生效，资源配置版本 为 "v1"时，配置无效。 | | flink_log_config | 否 | String | **参数解释：** 配置日志和状态。Flink 1.15及以上版本支持配置该参数。 **取值范围：** 包括：root_logger_level、loggers_level_of_class 日志级别取值说明请参考[表10]。 - **root_logger_level** 日志级别用于区分日志信息的重要性和紧急程度。根日志级别是全局的日志级别设置，它为整个应用程序提供了一个默认的日志级别。 当没有为特定的日志记录器或类设置日志级别时，根日志级别将被使用。例如，如果根日志级别设置为INFO，那么所有未单独设置级别的日志记录器都将输出INFO及以上级别的日志。 从低到高，日志级别的优先级通常为：TRACE\