- 最新动态
- 功能总览
- 服务公告
- 产品介绍
- 计费说明
- 快速入门
-
用户指南
- DLI作业开发流程
- 准备工作
- 创建弹性资源池和队列
- 创建数据库和表
- 数据迁移与数据传输
- 配置DLI访问其他云服务的委托权限
- 使用DLI提交SQL作业
- 使用DLI提交Flink作业
- 使用DLI提交Spark作业
- 使用Notebook实例提交DLI作业
- 使用CES监控DLI服务
- 使用AOM监控DLI服务
- 使用CTS审计DLI服务
- 权限管理
- DLI常用管理操作
- 最佳实践
-
开发指南
- 使用客户端工具连接DLI
- SQL作业开发指南
- Flink作业开发指南
- Spark Jar作业开发指南
-
语法参考
-
Spark SQL语法参考
- Spark SQL常用配置项说明
- Spark SQL语法概览
- Spark开源命令支持说明
- 数据库相关
- 表相关
- 数据相关
- 导出查询结果
- 跨源连接相关
- 视图相关
- 查看计划
- 数据权限相关
- 数据类型
- 自定义函数
-
内置函数
-
日期函数
- 日期函数概览
- add_months
- current_date
- current_timestamp
- date_add
- dateadd
- date_sub
- date_format
- datediff
- datediff1
- datepart
- datetrunc
- day/dayofmonth
- from_unixtime
- from_utc_timestamp
- getdate
- hour
- isdate
- last_day
- lastday
- minute
- month
- months_between
- next_day
- quarter
- second
- to_char
- to_date
- to_date1
- to_utc_timestamp
- trunc
- unix_timestamp
- weekday
- weekofyear
- year
-
字符串函数
- 字符串函数概览
- ascii
- concat
- concat_ws
- char_matchcount
- encode
- find_in_set
- get_json_object
- instr
- instr1
- initcap
- keyvalue
- length
- lengthb
- levenshtein
- locate
- lower/lcase
- lpad
- ltrim
- parse_url
- printf
- regexp_count
- regexp_extract
- replace
- regexp_replace
- regexp_replace1
- regexp_instr
- regexp_substr
- repeat
- reverse
- rpad
- rtrim
- soundex
- space
- substr/substring
- substring_index
- split_part
- translate
- trim
- upper/ucase
- 数学函数
- 聚合函数
- 分析窗口函数
- 其他函数
-
日期函数
- SELECT
-
标示符
- aggregate_func
- alias
- attr_expr
- attr_expr_list
- attrs_value_set_expr
- boolean_expression
- class_name
- col
- col_comment
- col_name
- col_name_list
- condition
- condition_list
- cte_name
- data_type
- db_comment
- db_name
- else_result_expression
- file_format
- file_path
- function_name
- groupby_expression
- having_condition
- hdfs_path
- input_expression
- input_format_classname
- jar_path
- join_condition
- non_equi_join_condition
- number
- num_buckets
- output_format_classname
- partition_col_name
- partition_col_value
- partition_specs
- property_name
- property_value
- regex_expression
- result_expression
- row_format
- select_statement
- separator
- serde_name
- sql_containing_cte_name
- sub_query
- table_comment
- table_name
- table_properties
- table_reference
- view_name
- view_properties
- when_expression
- where_condition
- window_function
- 运算符
-
Flink SQL语法参考
- Flink Opensource SQL1.15语法参考
- Flink Opensource SQL1.12语法参考
- Flink Opensource SQL1.10语法参考
-
HetuEngine SQL语法参考
-
HetuEngine SQL语法
- 使用前必读
- 数据类型
-
DDL 语法
- CREATE SCHEMA
- CREATE TABLE
- CREATE TABLE AS
- CREATE TABLE LIKE
- CREATE VIEW
- ALTER TABLE
- ALTER VIEW
- ALTER SCHEMA
- DROP SCHEMA
- DROP TABLE
- DROP VIEW
- TRUNCATE TABLE
- COMMENT
- VALUES
- SHOW语法使用概要
- SHOW SCHEMAS(DATABASES)
- SHOW TABLES
- SHOW TBLPROPERTIES TABLE|VIEW
- SHOW TABLE/PARTITION EXTENDED
- SHOW FUNCTIONS
- SHOW PARTITIONS
- SHOW COLUMNS
- SHOW CREATE TABLE
- SHOW VIEWS
- SHOW CREATE VIEW
- DML 语法
- DQL 语法
- 辅助命令语法
- 预留关键字
- SQL函数和操作符
- 数据类型隐式转换
- 附录
-
HetuEngine SQL语法
- Hudi SQL语法参考
- Delta SQL语法参考
-
Spark SQL语法参考
-
API参考
- API使用前必读
- API概览
- 如何调用API
- API快速入门
- 权限相关API
- 全局变量相关API
- 资源标签相关API
- 增强型跨源连接相关API
- 跨源认证相关API
- 弹性资源池相关API
- 队列相关API(推荐)
- SQL作业相关API
- SQL模板相关API
- Flink作业相关API
- Flink作业模板相关API
- Flink作业管理相关API
- Spark作业相关API
- Spark作业模板相关API
- 权限策略和授权项
- 历史API
- 公共参数
- SDK参考
- 场景代码示例
-
常见问题
- DLI产品咨询类
- DLI弹性资源池和队列类
-
DLI数据库和表类
- 为什么在DLI控制台中查询不到表?
- OBS表压缩率较高怎么办?
- 字符码不一致导致数据乱码怎么办?
- 删除表后再重新创建同名的表,需要对操作该表的用户和项目重新赋权吗?
- DLI分区内表导入的文件不包含分区列的数据,导致数据导入完成后查询表数据失败怎么办?
- 创建OBS外表,由于OBS文件中的某字段存在换行符导致表字段数据错误怎么办?
- join表时没有添加on条件,造成笛卡尔积查询,导致队列资源爆满,作业运行失败怎么办?
- 手动在OBS表的分区目录下添加了数据,但是无法查询到数据怎么办?
- 为什么insert overwrite覆盖分区表数据的时候,覆盖了全量数据?
- 跨源连接RDS表中create_date字段类型是datetime,为什么DLI中查出来的是时间戳呢?
- SQL作业执行完成后,修改表名导致datasize不正确怎么办?
- 从DLI导入数据到OBS,数据量不一致怎么办?
-
增强型跨源连接类
- 增强型跨源连接绑定队列失败怎么办?
- DLI增强型跨源连接DWS失败怎么办?
- 创建跨源成功但测试网络连通性失败怎么办?
- 怎样配置DLI队列与数据源的网络连通?
- 为什么DLI增强型跨源连接要创建对等连接?
- DLI创建跨源连接,绑定队列一直在创建中怎么办?
- 新建跨源连接,显示已激活,但使用时提示communication link failure错误怎么办?
- 跨源访问MRS HBase,连接超时,日志未打印错误怎么办?
- DLI跨源连接报错找不到子网怎么办?
- 跨源RDS表,执行insert overwrite提示Incorrect string value错误怎么办?
- 创建RDS跨源表提示空指针错误怎么办?
- 对跨源DWS表执行insert overwrite操作,报错:org.postgresql.util.PSQLException: ERROR: tuple concurrently updated
- 通过跨源表向CloudTable Hbase表导入数据,executor报错:RegionTooBusyException
- 通过DLI跨源写DWS表,非空字段出现空值异常怎么办?
- 更新跨源目的端源表后,未同时更新对应跨源表,导致insert作业失败怎么办?
- RDS表有自增主键时怎样在DLI插入数据?
-
SQL作业类
- SQL作业开发类
-
SQL作业运维类
- 用户导表到OBS报“path obs://xxx already exists”错误
- 对两个表进行join操作时,提示:SQL_ANALYSIS_ERROR: Reference 't.id' is ambiguous, could be: t.id, t.id.;
- 执行查询语句报错:The current account does not have permission to perform this operation,the current account was restricted. Restricted for no budget.
- 执行查询语句报错:There should be at least one partition pruning predicate on partitioned table XX.YYY
- LOAD数据到OBS外表报错:IllegalArgumentException: Buffer size too small. size
- SQL作业运行报错:DLI.0002 FileNotFoundException
- 用户通过CTAS创建hive表报schema解析异常错误
- 在DataArts Studio上运行DLI SQL脚本,执行结果报org.apache.hadoop.fs.obs.OBSIOException错误
- 使用CDM迁移数据到DLI,迁移作业日志上报UQUERY_CONNECTOR_0001:Invoke DLI service api failed错误
- SQL作业访问报错:File not Found
- SQL作业访问报错:DLI.0003: AccessControlException XXX
- SQL作业访问外表报错:DLI.0001: org.apache.hadoop.security.AccessControlException: verifyBucketExists on {{桶名}}: status [403]
- 执行SQL语句报错:The current account does not have permission to perform this operation,the current account was restricted. Restricted for no budget.
-
Flink作业类
- Flink作业咨询类
-
Flink SQL作业类
- 怎样将OBS表映射为DLI的分区表?
- Flink SQL作业Kafka分区数增加或减少,怎样不停止Flink作业实现动态感知?
- 在Flink SQL作业中创建表使用EL表达式,作业运行提示DLI.0005错误怎么办?
- Flink作业输出流写入数据到OBS,通过该OBS文件路径创建的DLI表查询无数据
- Flink SQL作业运行失败,日志中有connect to DIS failed java.lang.IllegalArgumentException: Access key cannot be null错误
- Flink SQL作业消费Kafka后sink到es集群,作业执行成功,但未写入数据
- Flink Opensource SQL如何解析复杂嵌套 JSON?
- Flink Opensource SQL从RDS数据库读取的时间和RDS数据库存储的时间为什么会不一致?
- Flink Opensource SQL Elasticsearch结果表failure-handler参数填写retry_rejected导致提交失败
- Kafka Sink配置发送失败重试机制
- 如何在一个Flink作业中将数据写入到不同的Elasticsearch集群中?
- 作业语义检验时提示DIS通道不存在怎么处理?
- Flink jobmanager日志一直报Timeout expired while fetching topic metadata怎么办?
- Flink Jar作业类
- Flink作业性能调优类
-
Spark作业相类
- Spark作业开发类
-
Spark作业运维类
- 运行Spark作业报java.lang.AbstractMethodError
- Spark作业访问OBS数据时报ResponseCode: 403和ResponseStatus: Forbidden错误
- 有访问OBS对应的桶的权限,但是Spark作业访问时报错 verifyBucketExists on XXXX: status [403]
- Spark作业运行大批量数据时上报作业运行超时异常错误
- 使用Spark作业访问sftp中的文件,作业运行失败,日志显示访问目录异常
- 执行作业的用户数据库和表权限不足导致作业运行失败
- 为什么Spark3.x的作业日志中打印找不到global_temp数据库
- 在使用Spark2.3.x访问元数据时,DataSource语法创建avro类型的OBS表创建失败
- DLI资源配额类
- DLI权限管理类
- DLI API类
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
查询作业列表
功能介绍
查询当前用户的作业列表,可以根据作业ID作为ID,查询大于ID或小于ID的限定条数的作业,默认查询全部状态的作业,也可以设定运行中或其他状态条件。
调试
您可以在API Explorer中调试该接口。
URI
- URI格式
- 参数说明
表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
指定标签过滤。
请求消息
无请求参数。
响应消息
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
is_success |
否 |
String |
执行请求是否成功。“true”表示请求执行成功。 |
message |
否 |
String |
系统提示信息,执行成功时,信息可能为空。 |
job_list |
否 |
Object |
作业列表信息。请参见表4。 |
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
total_count |
否 |
Integer |
作业查询结果条数。 |
jobs |
否 |
Array of Objects |
作业信息。请参见表5。 |
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
job_id |
否 |
Long |
作业ID。 |
name |
否 |
String |
作业名称。长度限制:0-57个字符。 |
desc |
否 |
String |
作业描述。长度限制:0-512个字符。 |
user_name |
否 |
String |
用户名,当“show_detail”为“false”时独有。 |
job_type |
否 |
String |
作业类型。
|
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”时独有。
|
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”时独有。 |
queue_name |
否 |
String |
队列名称。 |
edge_group_ids |
否 |
Array of Strings |
边缘计算组ID列表。多个ID以逗号分隔。 |
restart_times |
否 |
Integer |
重启次数。 |
savepoint_path |
否 |
String |
手动产生的Checkpoint的保存路径。 |
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
checkpoint_enabled |
否 |
Boolean |
是否开启作业自动快照功能。
默认为“false”。 |
checkpoint_mode |
否 |
String |
快照模式,。两种可选:
默认值为“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”。 |
parallel_number |
否 |
Integer |
用户设置的作业并行数。 “show_detail”为“true”时独有。
默认为“1”。 |
restart_when_exception |
否 |
Boolean |
是否开启异常重启功能。 |
idle_state_retention |
否 |
Integer |
空闲状态过期周期。 |
udf_jar_url |
否 |
String |
用户已上传到DLI资源管理系统的程序包名,用户sql作业的udf jar通过该参数传入。 |
dirty_data_strategy |
否 |
String |
作业脏数据策略。
|
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”。 |
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镜像。关于如何使用自定义镜像,请参考《数据湖探索用户指南》。 |
feature |
否 |
String |
自定义作业特性。表示用户作业使用的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”的值为准。 |
请求示例
无
响应示例
{ "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 } ] } }
错误码
调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码。