创建脚本
功能介绍
创建一个新脚本,当前支持的脚本类型有DLI SQL、Flink SQL、RDS SQL、Spark SQL、Hive SQL、DWS SQL、Shell和Presto。
- 参数说明
表1 URI参数说明 参数名
是否必选
参数类型
说明
project_id
是
String
项目编号,获取方法请参见项目ID和帐号ID。
请求消息
参数名 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
workspace |
否 |
String |
工作空间id。
|
参数名 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
name |
是 |
String |
脚本名称,只能包含五种字符:英文字母、数字、中文、中划线和点号,且长度小于等于128个字符。脚本名称不能重复。 |
type |
是 |
String |
脚本类型,包含:
|
content |
是 |
String |
脚本内容,最大支持64KB。 |
directory |
否 |
String |
脚本所在目录路径。 通过DataArts Studio管理控制台 > 数据开发,左侧列表选择 。在脚本的目录树上,可以查看到当前已经创建的目录,默认在根目录/。 |
connectionName |
否 |
String |
脚本关联的连接名称。当type参数值为DLISQL、SparkSQL、HiveSQL、DWSSQL、Shell、PRESTO其中之一时,这个参数是必选的。用户可以通过查询连接列表接口获取当前系统中已经存在的连接。默认值为空。 |
database |
否 |
String |
执行SQL语句所关联的数据库,当type参数值为DLISQL、SparkSQL、HiveSQL、DWSSQL、PRESTO其中之一时,才支持此参数。
|
queueName |
否 |
String |
DLI资源队列名称,当type参数值为DLI SQL时,才支持此参数。可以通过《数据湖探索 API参考》的“查询队列列表接口”获取队列信息。默认值为空。 |
configuration |
否 |
map <String,Object> |
用户定义适用于此作业的配置参数,当type参数值为DLI SQL时,才支持此参数。当前支持的配置项列表请参考《数据湖探索 API参考》的“提交SQL作业接口”的conf参数说明。默认值为空。 |
description |
否 |
String |
描述,长度不能超过255个字符。 |
响应消息
无
示例
创建一个脚本。
- 请求
POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/scripts { "name":"echoTimeShell", "type":"Shell", "content":"echo a", "connectionName":"con" }
- 成功响应
- 失败响应
{ "error_code":"DLF.6247", "error_msg":"The script type is not specified." }
状态码
状态码请参见状态码。