Help Center/ DataArts Studio/ API Reference/ API Overview/ DataArts Factory API (V1) Overview
Updated on 2024-11-06 GMT+08:00

DataArts Factory API (V1) 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. You are advised to use the APIs in Management Center for connection management.

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

Maximum API Requests per Second

Maximum User Requests per Second

Creating a Connection (to Be Taken Offline)

This API is used to create a connection.

None

None

Querying a Connection List (to Be Taken Offline)

This API is used to query a connection list.

None

None

Querying Connection Details (to Be Taken Offline)

This API is used to query details of a connection.

None

None

Modifying a Connection (to Be Taken Offline)

This API is used to edit a connection.

None

None

Deleting a Connection (to Be Taken Offline)

This API is used to delete a connection.

None

None

Exporting a Connection (to Be Taken Offline)

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

None

None

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.

None

None

Script Development

Table 3 Script development

API

Description

Maximum API Requests per Second

Maximum User Requests per Second

Creating a Script

This API is used to create a script.

300

30

Modifying a Script

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

300

30

Querying Script Details

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

300

30

Querying a Script List

This API is used to query a script list.

300

30

Querying the Execution Result of a Script Instance

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

300

30

Deleting a Script

This API is used to delete a specific script.

300

30

Executing a Script

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

300

30

Stopping Executing a Script Instance

This API is used to stop executing a script instance.

300

30

Resource Management

Table 4 Resource management

API

Description

Maximum API Requests per Second

Maximum User Requests per Second

Creating a Resource

This API is used to create a resource.

100

10

Querying a Resource List

This API is used to query a resource list.

100

10

Modifying a Resource

This API is used to modify a resource.

100

10

Deleting a Resource

This API is used to delete a resource.

100

10

Querying Resource Details

This API is used to query resource details.

300

30

Job Development

Table 5 Job development

API

Description

Maximum API Requests per Second

Maximum User Requests per Second

Creating a Job

This API is used to create a job.

300

30

Modifying a Job

This API is used to modify a job.

300

30

Querying a Job List

This API is used to query a job list.

300

30

Querying Job Details

This API is used to query job details.

100

10

Querying a Job File

This API is used to query a job file.

100

10

Exporting a Job

This API is used to export a job.

100

10

Exporting Jobs

This API is used to export jobs.

100

10

Importing Jobs

This API is used to import jobs.

100

10

Executing a Job Immediately

This API is used to execute a job immediately.

300

30

Starting a Job

This API is used to start a job.

300

30

Stopping a Job

This API is used to stop a job.

300

30

Deleting a Job

This API is used to delete a job.

300

30

Stopping a Job Instance

This API is used to stop a job instance.

300

30

Rerunning a Job Instance

This API is used to rerun a job instance.

300

30

Querying Running Status of a Real-Time Job

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

300

30

Querying a Job Instance List

This API is used to query a job instance list.

300

30

Querying Job Instance Details

This API is used to query job instance details.

300

30

Querying System Task Details

This API is used to query details about asynchronous tasks.

100

10