Help Center/ DataArts Studio/ API Reference/ DataArts Factory APIs/ Script Development APIs/ Executing a Script
Updated on 2022-09-15 GMT+08:00
View PDF

Executing a Script

Function

This API is used to execute a specific script, which can be a DWS SQL, DLI SQL, RDS SQL, Flink SQL, Hive SQL, Presto SQL, or Spark SQL script. A script instance is generated each time the script is executed. You can call the API Querying the Execution Result of a Script Instance to obtain script execution results.

URI

  • URI format

    POST /v1/{project_id}/scripts/{script_name}/execute

  • 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

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 Parameters

Parameter

Mandatory

Type

Description

params

No

Object

Script parameters of the Map<String,String> type. If a parameter is defined in the script, the parameter value is carried in the params. By default, this parameter is left blank.

Script parameters refer to the parameters in the script content, as shown in the following figure.

Response

Table 4 Response parameters

Parameter

Mandatory

Type

Description

instanceId

Yes

String

ID of the instance that executes the script. You can obtain the execution result by using the instance ID in Querying the Execution Result of a Script Instance.

Example Request

  • Request 
    POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/scripts/dws_sql/execute
{
"params":{"tableVar":"citys",
"time":"2019-07-25"}
}

Example Response

  • Success response

    HTTP status code 200

  • Failure response

    HTTP status code 400

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

Status Codes

See Status Codes.

Parent topic: Script Development APIs