错误码
8 SQL 作业相关 API
8.3 作业相关 API
8.3.5 查询所有作业
功能介绍
该API用于查询当前project下的所有作业的信息。
调试
您可以在API Explorer中调试该接口。
URI
● URI格式：
GET /v1.0/{project_id}/jobs
● 参数说明
表8-65 URI 参数 参数名称 是否必
选
参数类 型
说明
project_id 是 String 项目编号，用于资源隔离。获取方式请参考 获取项目ID。
表8-66 query 参数 参数名称 是否必
选
参数类 型
说明
page-size 否 Intege
r 每页显示的最大作业个数，范围: [1, 100]。默 认值：50。
current-page 否 Intege
r 当前页码，默认为第一页。
start 否 Long 用于查询开始时间在该时间点之后的作业。时 间格式为unix时间戳，单位：毫秒。
end 否 Long 用于查询开始时间在该时间点之前的作业。时 间格式为unix时间戳，单位：毫秒。
job-type 否 String 指定查询的作业类型，包含DDL、DCL、
IMPORT、EXPORT、QUERY、INSERT、
DATA_MIGRATION、UPDATE、DELETE、
RESTART_QUEUE、SCALE_QUEUE，若要查询
API 参考 8 SQL 作业相关 API
参数名称 是否必 选
参数类 型
说明
job-status 否 String 指定查询的作业状态。
job-id 否 String 指定查询的作业ID。
queue_n
ame 否 String 指定queue_name作为作业过滤条件，查询在指 定queue上运行的作业。
sql_patte
rn 否 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
其中，“=”需要转义为“%3Dv”，“k1”为 标签键，“v1”为标签值。
说明
带入query参数的URL示例如下：
GET /v1.0/{project_id}/jobs?page-size={size}
¤t-page={page_number}&start={start_time}&end={end_time} &job-type={QUERY}&queue_name={test}&order={duration_desc}
请求消息
无请求参数。
响应消息
表8-67 响应参数 参数名
称
是否必选 参数类型 说明
is_succe
ss 是 Boolean 执行请求是否成功。“true”表示请求执 行成功。
API 参考 8 SQL 作业相关 API
参数名 称
是否必选 参数类型 说明
messag
e 是 String 系统提示信息，执行成功时，信息可能为
空。
job_cou
nt 是 Integer 作业总个数。
jobs 是 Array of
Objects 作业信息。具体参数请参见表8-68。
表8-68 jobs 参数
参数名称 是否必
选
参数类 型
说明
job_id 是 String 作业ID。
job_type 是 String 作业类型。
queue_name 是 String 作业提交的队列。
owner 是 String 提交作业的用户。
start_time 是 Long 作业开始的时间。是单位为“毫秒”的时间 戳。
duration 是 Long 作业运行时长，单位毫秒。
status 是 String 此作业的当前状态，包含提交
（LAUNCHING）、运行中（RUNNING）、
完成（FINISHED）、失败（FAILED）、取消
（CANCELLED）。
input_row_cou
nt 否 Long Insert作业执行过程中扫描的记录条数。
bad_row_count 否 Long Insert作业执行过程中扫描到的错误记录数。
input_size 是 Long 作业执行过程中扫描文件的大小。
result_count 是 Integer 当前作业返回的结果总条数或insert作业插入 的总条数。
database_name 否 String 记录其操作的表所在的数据库名称。类型为 Import和Export作业才有
“database_name”属性。
table_name 否 String 记录其操作的表名称。类型为Import和 Export作业才有“table_name”属性。
with_column_h
eader 否 Boolea
n Import类型的作业，记录其导入的数据是否 包括列名。
API 参考 8 SQL 作业相关 API
参数名称 是否必 选
参数类 型
说明
statement 是 String 作业执行的SQL语句。
tags 否 Array
ofObject s
{ "is_success": true, "message": "", "job_count": 1, "jobs": [ {
"detail": "{\"type\":\"struct\",\"fields\":[{\"name\":\"name\",\"type\":\"string\",\"nullable\":true,
\"metadata\":{}},{\"name\":\"age\",\"type\":\"integer\",\"nullable\":true,\"metadata\":{}}]}", "duration": 17731,
"end_time": 1502349821460, "input_size": 0,
"job_id": "37286cc7-0508-4ffd-b636-951c8a5c75de", "job_type": "QUERY",
"message": "", "owner": "tenant1", "queue_name": "queue1", "result_count": 3,
"start_time": 1502349803729,
"statement": "select * from t_json_002", "status": "FINISHED",
"with_column_header": false }
]}
状态码
状态码如表8-70所示。
API 参考 8 SQL 作业相关 API
表8-70 状态码
状态码 描述
200 查询成功。
400 请求错误。
500 内部服务器错误。
错误码
调用接口出错后，将不会返回上述结果，而是返回错误码和错误信息，更多介绍请参 见错误码。