Creating a Script

Function

This API is used to create a script. Currently, the following script types are supported: DLI SQL, Flink SQL, RDS SQL, Spark SQL, Hive SQL, DWS SQL, Shell, and Presto.

URI

URI format
POST /v1/{project_id}/scripts

Parameter description

**Table 1** URI parameter
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.

Request

**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.

**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 4 MB is supported.
directory	No	String	Directory for storing the script. Access the DataArts Studio console and choose Data Development. 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. 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, DWSSQL, or PRESTO. If type is set to DLI SQL, obtain database information by calling the API for . 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 . 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 . By default, this parameter is left blank.
description	No	String	The description contains a maximum of 255 characters.

Response

None.

Example

Create a script.

Request

POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/scripts
{
"name":"echoTimeShell",
"type":"Shell",
"content":"echo a",
"connectionName":"con"
}

Success response
HTTP status code 204

Failure response

HTTP status code 400

{
    "error_code":"DLF.6247",
    "error_msg":"The script type is not specified."
}

Status Code

See Status Codes.

Parent topic: APIs to Be Taken Offline

Previous topic: Querying a System Task

Next topic: Modifying a Script

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel