查询作业状态
功能介绍
该API用于在作业提交后查询作业状态。
URI
- 参数说明
表1 URI 参数 参数名称
是否必选
参数类型
说明
project_id
是
String
项目编号，用于资源隔离。获取方式请参考获取项目ID。
job_id
是
String
作业ID。
请求消息
无请求参数。
响应消息
|
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
is_success |
是 |
Boolean |
执行请求是否成功。“true”表示请求执行成功。 |
|
message |
是 |
String |
系统提示信息，执行成功时，该值为空。 |
|
job_id |
是 |
String |
作业ID。可通过提交SQL作业（推荐）获取。 |
|
job_type |
是 |
String |
作业类型。包含DDL、DCL、IMPORT、EXPORT、QUERY、INSERT、DATA_MIGRATION、UPDATE、DELETE、RESTART_QUEUE、SCALE_QUEUE。 |
|
job_mode |
是 |
String |
作业执行模式：
|
|
queue_name |
是 |
String |
队列名称，用于显示作业是在该队列中提交的。 |
|
owner |
是 |
String |
提交作业的用户。 |
|
start_time |
是 |
Long |
作业开始的时间。是单位为“毫秒”的时间戳。 |
|
duration |
否 |
Long |
作业运行时长，单位毫秒。 |
|
status |
是 |
String |
此作业的当前状态，包含运行中（RUNNING）、规格变更中（SCALING）、提交中（LAUNCHING）、已完成（FINISHED）、已失败（FAILED）、已取消（CANCELLED）。 |
|
input_row_count |
否 |
Long |
Insert作业执行过程中扫描记录条数。 |
|
bad_row_count |
否 |
Long |
Insert作业执行过程中扫描到的错误记录数。 |
|
input_size |
是 |
Long |
作业执行过程中扫描文件的大小，单位字节。 |
|
result_count |
是 |
Integer |
当前作业返回的结果总条数或insert作业插入的总条数。 |
|
database_name |
否 |
String |
记录其操作的表所在的数据库名称。类型为IMPORT、EXPORT和QUERY的作业才有“database_name”属性。 |
|
table_name |
否 |
String |
记录其操作的表名称。类型为IMPORT、EXPORT和QUERY的作业才有“table_name”属性。 |
|
detail |
是 |
String |
相关列信息的Json字符串。 |
|
statement |
是 |
String |
作业执行的SQL语句。 |
|
tags |
否 |
Array of objects |
作业的标签。具体请参考表3。 |
请求示例
无
响应示例
{
"is_success": true,
"message": "",
"job_id": "208b08d4-0dc2-4dd7-8879-ddd4c020d7aa",
"job_type": "QUERY",
"job_mode":"async",
"queue_name": "default",
"owner": "test",
"start_time": 1509335108918,
"duration": 2523,
"status": "FINISHED",
"input_size": 22,
"result_count": 4,
"database_name":"dbtest",
"table_name":"tbtest",
"detail": "{\"type\":\"struct\",\"fields\":[{\"name\":\"id\",\"type\":\"integer\",\"nullable\":true,\"metadata\":{}},{\"name\":\"name\",\"type\":\"string\",\"nullable\":true,\"metadata\":{}}]}",
"statement": "select * from t1"
}
错误码
调用接口出错后，将不会返回上述结果，而是返回错误码和错误信息，更多介绍请参见错误码。
