修改脚本内容
功能介绍
本接口用以修改脚本的配置项或者脚本内容。
- 修改脚本时,需要指定待修改的脚本名称。
- 脚本名称和脚本类型不支持修改。
- 参数说明
表1 URI参数说明 参数名
是否必选
参数类型
说明
project_id
是
String
项目编号,获取方法请参见项目ID和账号ID。
script_name
是
String
脚本名称。
请求参数
参数名 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
workspace |
否 |
String |
工作空间id。
|
参数名 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
name |
是 |
String |
脚本名称,只能包含五种字符:英文字母、数字、中文、中划线和点号,且长度小于等于128个字符。脚本名称不能重复。 |
type |
是 |
String |
脚本类型,包含:
|
content |
是 |
String |
脚本内容,最大支持4M。 |
directory |
否 |
String |
脚本所在目录路径。 通过DataArts Studio管理控制台 > 数据开发,左侧列表选择 。在脚本的目录树上,可以查看到当前已经创建的目录,默认在根目录/。 |
connectionName |
否 |
String |
脚本关联的连接名称。当type参数值为DLISQL、SparkSQL、HiveSQL、DWSSQL、Shell、PRESTO、ClickHouseSQL、HetuEngineSQL、RDSSQL、ImpalaSQL、PYTHON、SparkPython其中之一时,这个参数是必选的。用户可以通过查询连接列表(待下线)接口获取当前系统中已经存在的连接。默认值为空。 |
database |
否 |
String |
执行SQL语句所关联的数据库,当type参数值为DLISQL、SparkSQL、HiveSQL、DWSSQL、PRESTO、ClickHouseSQL、ImpalaSQL、HetuEngineSQL、RDSSQL其中之一时,才支持此参数。
|
queueName |
是 |
String |
DLI资源队列名称,当type参数值为DLISQL时,才支持此参数。可以通过《数据湖探索 API参考》的“查询队列列表接口”获取队列信息。默认值为空。 |
configuration |
否 |
map <String,Object> |
用户定义适用于此作业的配置参数,当type参数值为DLISQL时,才支持此参数。当前支持的配置项列表请参考《数据湖探索 API参考》的“提交SQL作业接口”的conf参数说明。默认值为空。 |
description |
否 |
String |
描述,长度不能超过255个字符。 |
targetStatus |
否 |
String |
在开启审批开关后,需要填写该字段。表示创建脚本的目标状态,有三种状态:SAVED、SUBMITTED和PRODUCTION,分别表示脚本创建后是保存态,提交态,生产态。
|
approvers |
否 |
List<JobApprover> |
在开启审批开关后,需要填写该字段,表示脚本审批人,参考表4。 审批开关的配置请参见审批中心。 |
响应参数
无
请求示例
PUT /v1/b384b9e9ab9b4ee8994c8633aabc9505/scripts/echoTimeShell { "name": "echoTimeShell", "type": "Shell", "content": "echo a", "queueName": "default", "connectionName": "con" }
PUT /v1/b384b9e9ab9b4ee8994c8633aabc9505/scripts/echoTimeShell { "name": "echoTimeShell", "type": "Shell", "content": "echo a", "queueName": "default", "connectionName": "con", "approvers": [ { "approverName": "userName1" }, { "approverName": "userName2" } ] }