文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据开发API（V1）/ 脚本开发API/ 查询脚本列表
更新时间：2024-12-04 GMT+08:00
查看PDF
分享

查询脚本列表

功能介绍

此接口用于查询脚本列表，每次查询返回的脚本数量上限是1000个。

URI

  • URI格式

    GET /v1/{project_id}/scripts?offset={offset}&limit={limit}&scriptName={scriptName}

  • 参数说明
    表1 URI参数说明

    参数名

    是否必选

    参数类型

    说明

    project_id

    是

    String

    项目编号，获取方法请参见项目ID和账号ID。

    limit

    否

    Integer

    分页返回结果，指定每页最大记录数，范围[1,100]。

    默认值：10。

    offset

    否

    Integer

    分页的起始页，默认值为0。取值范围大于等于0。

    scriptName

    否

    String

    脚本名称。

请求参数

表2 请求Header参数

参数名

是否必选

参数类型

说明

workspace

否

String

工作空间id。

  • 如果不设置该参数，默认查询default工作空间下的数据。
  • 如果需要查询其他工作空间的数据，需要带上该消息头。

响应参数

参数名

是否必选

参数类型

说明

total

是

Integer

总的脚本个数。

scripts

是

List<Script>

脚本列表。
表3 Script参数说明

参数名

是否必选

参数类型

说明

name

是

String

脚本名称，只能包含五种字符：英文字母、数字、中文、中划线和点号，且长度小于等于128个字符。脚本名称不能重复。

id

是

String

脚本ID。

type

是

String

脚本类型，包含：

  • FlinkSQL
  • DLISQL
  • SparkSQL
  • HiveSQL
  • DWSSQL
  • RDSSQL
  • Shell
  • PRESTO
  • ClickHouseSQL
  • HetuEngineSQL
  • PYTHON
  • ImpalaSQL
  • SparkPython

content

是

String

脚本内容，最大支持64KB。

directory

否

String

脚本所在目录路径。

通过DataArts Studio管理控制台 > 数据开发，左侧列表选择“数据开发 > 脚本开发”。在脚本的目录树上，可以查看到当前已经创建的目录，默认在根目录/。

connectionName

否

String

脚本关联的连接名称。当type参数值为DLISQL、SparkSQL、HiveSQL、DWSSQL、Shell、PRESTO、ClickHouseSQL、ImpalaSQL、HetuEngineSQL、RDSSQL其中之一时，这个参数是必选的。用户可以通过查询连接列表（待下线）接口获取当前系统中已经存在的连接。默认值为空。

database

否

String

执行SQL语句所关联的数据库，当type参数值为DLISQL、SparkSQL、HiveSQL、DWSSQL、PRESTO、ClickHouseSQL、ImpalaSQL、HetuEngineSQL、RDSSQL其中之一时，才支持此参数。

  • type为DLISQL时，可以通过《数据湖探索 API参考》的“查询所有数据库”接口获取数据库信息。
  • type为其他类型的时候，需要通过JDBC方式连上集群，查询数据库信息。默认值为空。

queueName

否

String

DLI资源队列名称，当type参数值为DLISQL时，才支持此参数。可以通过《数据湖探索 API参考》的“查询队列列表接口”获取队列信息。默认值为空。

configuration

否

map <String,Object>

用户定义适用于此作业的配置参数，当type参数值为DLISQL时，才支持此参数。当前支持的配置项列表请参考《数据湖探索 API参考》的“提交SQL作业接口”的conf参数说明。默认值为空。

description

否

String

描述，长度不能超过255个字符。

请求示例

查询脚本列表。 
GET /v1/b384b9e9ab9b4ee8994c8633aabc9505/scripts

响应示例

  • 成功响应

    HTTP状态码 200

    {
    "total": 1,
    "scripts": [
        {
            "configuration": {},
            "connectionName": "mrs_spark",
            "content": "SELECT 1;",
            "database": "aaa",
            "description": "",
            "directory": "/",
            "id": "8abfd8a49035cf8a019035d37b550000",
            "name": "mrs_spark_sql",
            "type": "SparkSQL"
        }
    ]
}
  • 失败响应

    HTTP状态码 400

    {
    "error_code":"DLF.3051",
    "error_msg":"The request parameter is invalid."
}
父主题： 脚本开发API