Help Center/ DataArts Studio/ More Documents/ API Reference (Kuala Lumpur Region)/ DataArts Factory APIs/ APIs to Be Taken Offline/ Modifying a Script
Updated on 2022-08-17 GMT+08:00
Share

Modifying a Script

Function

This API is used to modify the configuration items or script contents of a script.

  • When modifying a script, specify the name of the script to be modified.
  • The script name and type cannot be modified.

URI

  • URI format

    PUT /v1/{project_id}/scripts/{script_name}

  • Parameter description
    Table 1 URI parameters

    Parameter

    Mandatory

    Type

    Description

    projectId

    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

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 64 KB 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 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.

Response

None.

Example

Modify the script content.

  • Request 
    PUT /v1/b384b9e9ab9b4ee8994c8633aabc9505/scripts/echoTimeShell
{
"content":"echo time",
"connectionName":"con"
}
  • Success response

    HTTP status code 204

  • Failure response

    HTTP status code 400

    {
    "error_code":"DLF.6201",
    "error_msg":"The script does not exist."
}
Parent topic: APIs to Be Taken Offline