错误码
8 SQL 作业相关 API
8.3 作业相关 API
8.3.3 提交 SQL 作业（推荐）
● 成功响应样例：
{ "is_success": true,
"message": "export all data from table db2.t2 to path obs://home/data1/DLI/test started", "job_id": "828d4044-3d39-449b-b32c-957f7cfadfc9",
"job_mode":"async"
}
状态码
状态码如表8-55所示。
表8-55 状态码
状态码 描述
200 导出成功。
400 请求错误。
500 内部服务器错误。
错误码
调用接口出错后，将不会返回上述结果，而是返回错误码和错误信息，更多介绍请参 见错误码。
8.3.3 提交 SQL 作业（推荐）
功能介绍
该API用于通过执行SQL语句的方式向队列提交作业。
作业包含以下类型：DDL、DCL、IMPORT、QUERY和INSERT。其中，IMPORT与导 入数据的功能一致，区别仅在于实现方式不同。
另外，用户可使用其他API来对作业进行查询和管理。具体操作有：
● 查询作业状态
● 查询作业详细信息
● 查询作业结果-方式二（废弃）
● 导出查询结果
● 查询所有作业
● 取消作业（推荐）
说明
API 参考 8 SQL 作业相关 API
调试
您可以在API Explorer中调试该接口。
URI
● URI格式：
POST /v1.0/{project_id}/jobs/submit-job
● 参数说明
表8-56 URI 参数 参数名称 是否
必选 参数类
型 说明
project_i
d 是 String 项目编号，用于资源隔离。获取方式请参考获取 项目ID。
请求消息
表8-57 请求参数 参数名称 是否必
选
参数类型 说明
sql 是 String 待执行的SQL语句。
currentdb 否 String SQL语句执行所在的数据库。当创建新数据库 时，不需要提供此参数。
queue_na
me 否 String 待提交作业的队列名称，名称只能包含数字、英 文字母和下划线，但不能是纯数字，且不能以下 划线开头。
conf 否 Array of
Strings 用户以“key/value”的形式设置用于此作业的 配置参数。目前支持的配置项请参考表8-58。
tags 否 Array of
Objects 作业的标签。具体请参考表8-59。
表8-58 conf 参数说明
参数名称 默认值 描述
spark.sql.files.maxRec
ordsPerFile 0 要写入单个文件的最大记录数。如果该值为 零或为负，则没有限制。
API 参考 8 SQL 作业相关 API
参数名称 默认值 描述 spark.sql.autoBroadca
stJoinThreshold 20971520
0 配置执行连接时显示所有工作节点的表的最
大字节大小。通过将此值设置为“-1”，可 以禁用显示。
说明当前仅支持运行命令ANALYZE TABLE COMPUTE statistics noscan的配置单元元存储表，和直接根 据数据文件计算统计信息的基于文件的数据源
false 在动态模式下，Spark不会删除前面的分区，
只覆盖那些运行时没有写入数据的分区。
spark.sql.files.maxPart
itionBytes 13421772
8 读取文件时要打包到单个分区中的最大字节
数。
spark.sql.badRecordsP
ath - Bad Records的路径。
dli.sql.sqlasync.enable
d false DDL和DCL语句是否异步执行，值为“true”
时启用异步执行。
dli.sql.job.timeout - 设置作业运行超时时间，超时取消。单位：
毫秒。
ess 是 Boolean 请求发送是否成功。“true”表示请求发送成功。
messag 是 String 系统提示信息，执行成功时，信息可能为空。
API 参考 8 SQL 作业相关 API
参数名 称
是否 必选
参数类型 说明
job_id 是 String 此SQL语句将生成并提交一个新作业，返回此作业 的ID，可用于获取作业状态和作业结果。
job_typ
e 是 String 作业类型。
● DDL
● DCL
● IMPORT
● EXPORT
● QUERY
● INSERT schema 否 Array of
objects 当语句类型为DDL时，返回其结果的列名称及类 型。
rows 否 Array of
objects 当语句类型为DDL时，直接返回其执行结果。
job_mo "sql": "desc table1", "queue_name": "default", "conf": [
{ "is_success": true, "message": "{""}",
"job_id": "8ecb0777-9c70-4529-9935-29ea0946039c", "job_type": "DDL",
"job_mode":"sync", "schema": [ {
"col_name": "string"
},
API 参考 8 SQL 作业相关 API
{
"data_type": "string"
}, {
"comment": "string"
} ], "rows": [ [ "c1", "int", null ], [ "c2", "string", null ] ]}
状态码
状态码如表8-61所示。
表8-61 状态码
状态码 描述
200 提交成功。
400 请求错误。
500 内部服务器错误。
错误码
调用接口出错后，将不会返回上述结果，而是返回错误码和错误信息，更多介绍请参 见错误码。