Querying a Script

Function

This API is used to query a script, including the script type and script content.

URI

• URI format

  GET /v1/{project_id}/scripts/{script_name}

• Parameter description

  Table 1 URI parameters

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Project ID. For details about how to obtain a project ID, see Project ID and Account ID.
  script_name	Yes	String	Script name.

Request Parameters

Table 2 Request header parameter

Parameter	Mandatory	Type	Description
workspace	No	String	Workspace ID. If this parameter is not set, data in the default workspace is queried by default. To query data in other workspaces, this header must be carried.

Response Parameters

Table 3 Script parameters

Parameter	Mandatory	Type	Description
name	Yes	String	Script name. The name contains a maximum of 128 characters, including only letters, numbers, hyphens (-), and periods (.). The script name must be unique.
type	Yes	String	Script type. FlinkSQL DLISQL SparkSQL HiveSQL DWSSQL RDSSQL Shell PRESTO
content	Yes	String	Script content. A maximum of 64 KB is supported.
directory	No	String	Directory for storing the script. Access the DataArts Studio console and choose DataArts Factory. In the left navigation pane, choose Development > Develop Script. In the directory tree of the script, you can view the created directories. The default directory is the root directory.
connectionName	No	String	Name of the connection associated with the script. This parameter is mandatory when type is set to DLISQL, SparkSQL, HiveSQL, DWSSQL, Shell, or PRESTO. To obtain the existing connections, refer to the instructions in Querying a Connection List (to Be Taken Offline). By default, this parameter is left blank.
database	No	String	Database associated with an SQL statement. This parameter is available only when type is set to DLISQL, SparkSQL, HiveSQL, or DWSSQL. If type is set to DLISQL, obtain database information by calling the API for querying all databases in the Data Lake Insight API Reference. Connect to the cluster in JDBC mode to query database information if type is not set to DLISQL. By default, this parameter is left blank.
queueName	No	String	Queue name of the DLI resource. This parameter is available only when type is set to DLISQL. You can obtain the queue information by calling the API for "Querying All Queues" in the Data Lake Insight API Reference. By default, this parameter is left blank.
configuration	No	map <String,Object>	Configuration defined by a user for the job. This parameter is available only when type is set to DLISQL. For details about the supported configuration items, see conf parameter description in the "Submitting a SQL Job" section of the Data Lake Insight API Reference. By default, this parameter is left blank.
description	No	String	Description of the script. The description contains a maximum of 255 characters.
autoAcquireLock	No	boolean	Whether to automatically obtain the edit lock parameters. The default value is true.

Example Request

GET /v1/b384b9e9ab9b4ee8994c8633aabc9505/scripts/scriptName

Example Response

• Success response

  HTTP status code 200

  {
      "configuration":{},
      "connectionName":"mrs_spark",
      "content":"SELECT 1;",
      "database":"aaa",
      "description":"",
      "directory":"/",
      "name":"mrs_spark_sql",
      "type":"SparkSQL"
  }
  

• Failure response

  HTTP status code 400

  {
      "error_code":"DLF.6201",
      "error_msg":"The script does not exist."
  }
  

Status Codes

See Status Codes.

last updated: 2024-11-13 13:47 UTC - commit: db9c60a6c98025320fa32706a5e58cd02cf7d7f1