Help Center/ DataArts Studio/ More Documents/ API Reference (Ally Region)/ API Overview/ DataArts Factory API Overview
Updated on 2026-01-30 GMT+08:00
View PDF
Share

DataArts Factory API Overview

Table 1 DataArts Factory API (V1) types

Type

Description

Connection Management (to Be Taken Offline)

Connection management APIs

NOTE:

The connection management capability is provided by Management Center. This API is no longer maintained.

Script Development

Script development APIs

Resource Management

Resource management APIs

Job Development

Job development APIs

Connection Management (to Be Taken Offline)

Table 2 Connection management (to be taken offline)

API

Description

Creating a Connection (to Be Taken Offline)

This API is used to create a connection.

Querying a Connection List (to Be Taken Offline)

This API is used to query a connection list.

Querying Connection Details (to Be Taken Offline)

This API is used to query details of a connection.

Modifying a Connection (to Be Taken Offline)

This API is used to edit a connection.

Deleting a Connection (to Be Taken Offline)

This API is used to delete a connection.

Exporting a Connection (to Be Taken Offline)

This API is used to export all connection information that is compressed in ZIP format.

Importing a Connection (to Be Taken Offline)

This API is used to import one or more connection files from OBS to the Data Development module.

Script Development

Table 3 Script development

API

Description

Creating a Script

This API is used to create a script.

Modifying a Script

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

Querying Script Details

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

Querying a Script List

This API is used to query a script list.

Querying the Execution Result of a Script Instance

This API is used to obtain the execution status and result of a script instance.

Deleting a Script

This API is used to delete a specific script.

Executing a Script

This API is used to execute a specified script. Each time a script is executed, a script instance is generated.

Stopping Executing a Script Instance

This API is used to stop executing a script instance.

Resource Management

Table 4 Resource management

API

Description

Creating a Resource

This API is used to create a resource.

Querying a Resource List

This API is used to query a resource list.

Modifying a Resource

This API is used to modify a resource.

Deleting a Resource

This API is used to delete a resource.

Querying Resource Details

This API is used to query resource details.

Job Development

Table 5 Job development

API

Description

Creating a Job

This API is used to create a job.

Modifying a Job

This API is used to modify a job.

Querying a Job List

This API is used to query a job list.

Querying Job Details

This API is used to query job details.

Querying a Job File

This API is used to query a job file.

Exporting a Job

This API is used to export a job.

Exporting Jobs

This API is used to export jobs.

Importing Jobs

This API is used to import jobs.

Executing a Job Immediately

This API is used to execute a job immediately.

Starting a Job

This API is used to start a job.

Stopping a Job

This API is used to stop a job.

Deleting a Job

This API is used to delete a job.

Stopping a Job Instance

This API is used to stop a job instance.

Rerunning a Job Instance

This API is used to rerun a job instance.

Querying Running Status of a Real-Time Job

This API is used to query the running status of a real-time job.

Querying a Job Instance List

This API is used to query a job instance list.

Querying Job Instance Details

This API is used to query job instance details.

Querying System Task Details

This API is used to query details about asynchronous tasks.
Parent topic: API Overview