Help Center/ DataArts Studio/ API Reference/ DataArts Factory APIs (V2)/ Script Development APIs/ Querying the Script List
Updated on 2025-11-24 GMT+08:00
View PDF

Querying the Script List

Function

This API is used to query the script list.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/factory/scripts

Table 1 Path 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.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

The maximum number of records on each page. The value ranges from 1 to 100.

The default value is 10.

offset

No

Integer

Start page of the paging list. The default value is 0. The value must be greater than or equal to 0.

script_name

No

String

Script name

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

workspace

Yes

String

Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.

X-Auth-Token

No

String

IAM token, which is obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header). This parameter is mandatory when token authentication is used. The value contains 0 to 4096 characters.

X-Project-Id

No

String

project_id: project ID. For details about how to obtain the project ID and account ID, see Project ID and Account ID.

This field is mandatory for API requests that use AK/SK authentication in multi-project scenarios.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total

Integer

The total number of scripts.

scripts

Array of ScriptInfo objects

Script List
Table 5 ScriptInfo

Parameter

Type

Description

name

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

String

Script Type

  • FlinkSQL: Flink SQL

  • DLISQL: DLI SQL

  • SparkSQL: MRS Spark SQL

  • HiveSQL: MRS Hive SQL

  • DWSSQL: DWS SQL

  • RDSSQL: RDS SQL

  • Shell: Shell script

  • PYTHON: Python script

  • PRESTO: MRS Presto SQL

  • ClickHouseSQL: MRS ClickHouse SQL

  • HetuEngineSQL: MRS HetuEngine SQL

  • ImpalaSQL: MRS Impala SQL

  • SparkPython: MRS Spark Python script

directory

String

Path of the script

Log in to the DataArts Studio management console and choose Data Development > Develop Script from the navigation pane. In the directory tree of the script, you can view the created directories. The default directory is the root directory.

id

String

Script ID.

create_user

String

Script creator

connection_name

String

Name of the connection associated with the script. This parameter is mandatory when type is set to DLISQL, (tag:nohcs)SparkSQL, HiveSQL, DWSSQL, Shell, PRESTO, ClickHouseSQL, ImpalaSQL, HetuEngineSQL, or RDSSQL. You can obtain existing connections in the system by calling the API for querying the connection list (to be brought offline). It is left blank by default.

database

String

Database associated with an SQL statement. This parameter is available only when type is set to DLISQL, (tag:nohcs)SparkSQL, HiveSQL, DWSSQL, PRESTO, ClickHouseSQL, ImpalaSQL, HetuEngineSQL, or RDSSQL.

  • When type is set to DLISQL, you can view all database interfaces to obtain database information.

  • If type is set to another value, you need to connect to the cluster in JDBC mode to query database information. It is left blank by default.

queue_name

String

DLI resource queue name. This parameter is available only when type is set to DLISQL. You can obtain the queue information by calling the API for querying the queue list. It is left blank by default.

configuration

Object

User-defined configuration parameters applicable to the job. This parameter is available when type is set to DLISQL. For details about the supported configuration items, see the conf parameter description of DLI. It is left blank by default.

description

String

Description of the connection. The description contains a maximum of 255 characters.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

Query a script list.

GET /v2/b384b9e9ab9b4ee8994c8633aabc9505/factory/scripts

Example Responses

Status code: 200

The query is successful, and the script list is returned.

{
  "total" : 2,
  "scripts" : [ {
    "connection_name" : "hive_test",
    "id" : "ff8080819627db89019627ee57cb0007;",
    "create_user" : "test_user",
    "database" : "default",
    "description" : "",
    "directory" : "/",
    "name" : "hive_test_sql",
    "type" : "HiveSQL"
  }, {
    "connection_name" : "hots_test_xie",
    "id" : "ff8080819627db89019647ee57cb0007;",
    "create_user" : "test_user",
    "description" : "",
    "directory" : "/",
    "name" : "test_shell",
    "type" : "Shell"
  } ]
}

Status code: 400

If the query fails, an error message is returned.

{
  "error_code" : "DLF.3051",
  "error_msg" : "The request parameter is invalid."
}

Status Codes

Status Code

Description

200

The query is successful, and the script list is returned.

400

If the query fails, an error message is returned.
Parent Topic: Script Development APIs