# 查询脚本信息 - ShowScript #### 功能介绍 此接口可以查询指定脚本的定义，包括脚本类型和脚本内容。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DGC/doc?api=ShowScript)中调试该接口，支持自动认证鉴权。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dataartsstudio/abcd.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI - URI格式 GET /v1/{project_id}/scripts/{script_name} - 参数说明 表1URI参数说明 | 参数名 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | project_id | 是 | String | 项目编号，获取方法请参见[项目ID和账号ID](https://support.huaweicloud.com/api-dataartsstudio/projectid_accountid.html)。 | | script_name | 是 | String | 脚本名称。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | version | 否 | integer | 脚本版本号，若传入版本号，则查询指定版本号的脚本；若不传入，则查询最新的版本脚本。 | | status | 否 | String | 当不指定version时，可通过status查询脚本的状态。默认为SAVED，即查询的是最新提交的版本，当status为PUBLISHED时查询的是脚本的生产版本。 | #### 请求参数 表3请求Header参数 | 参数名 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | workspace | 否 | String | 工作空间id。获取方法请参见[实例ID和工作空间ID](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0350.html)。 - 如果不设置该参数，默认查询default工作空间下的数据。 - 如果需要查询其他工作空间的数据，需要带上该消息头。 说明： - 多个DataArts Studio实例需要指定工作空间。 - 当工作空间里面没有default工作空间时，工作空间为必填参数，否则会报错。 | #### 响应参数 表4Script参数说明 | 参数名 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | name | 是 | String | 脚本名称，只能包含六种字符：英文字母、数字、中文、中划线、下划线和点号，且长度小于等于128个字符。脚本名称不能重复。 | | id | 是 | String | 脚本ID。 | | type | 是 | String | 脚本类型，包含： - FlinkSQL - DLISQL - SparkSQL - HiveSQL - DWSSQL - RDSSQL - Shell - PRESTO - ClickHouseSQL - HetuEngineSQL - PYTHON - ImpalaSQL - SparkPython - GBase SQL | | content | 是 | String | 脚本内容。 | | 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时，可以通过[查看所有数据库](https://support.huaweicloud.com/api-dli/dli_02_0029.html)接口获取数据库信息。 - type为其他类型的时候，需要通过JDBC方式连上集群，查询数据库信息。默认值为空。 | | queueName | 否 | String | DLI资源队列名称，当type参数值为DLISQL时，才支持此参数。可以通过[查询队列列表接口](https://support.huaweicloud.com/api-dli/dli_02_0196.html)获取队列信息。默认值为空。 | | configuration | 否 | map \ | 用户定义适用于此作业的配置参数，当type参数值为DLISQL时，才支持此参数。当前支持的配置项列表请参考[conf参数说明](https://support.huaweicloud.com/api-dli/dli_02_0102.html)。默认值为空。 | | description | 否 | String | 描述，长度不能超过255个字符。 | | autoAcquireLock | 否 | boolean | 自动获取编辑锁参数，默认为true。 | | version | 否 | Integer | 脚本版本。 | #### 请求示例 ``` GET /v1/b384b9e9ab9b4ee8994c8633aabc9505/scripts/scriptName ``` #### 响应示例 - 成功响应 HTTP状态码 200 ``` { "configuration":{}, "connectionName":"mrs_spark", "content":"SELECT 1;", "database":"aaa", "description":"", "directory":"/", "id": "8abfd8a49035cf8a019035d37b550000", "name":"mrs_spark_sql", "type":"SparkSQL" } ``` - 失败响应 HTTP状态码 400 ``` { "error_code":"DLF.6201", "error_msg":"The script does not exist." } ``` #### 状态码 状态码请参见[状态码](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0310.html)。