Help Center/ DataArts Studio/ API Reference/ API Overview/ Management Center API Overview
Updated on 2025-11-17 GMT+08:00

Management Center API Overview

Table 1 Management Center API types

Type

Description

Data Connection Management

Data connection management APIs

Instance Purchase

Instance purchase APIs

Workspace Management

Workspace management APIs

Instance Management

Instance management APIs

Workspace User Management

Workspace user management APIs

Data Source Metadata Acquisition

Data source metadata acquisition APIs

Instance Specifications Change

Instance specifications change APIs

Data Connection Management

Table 2 Data connection management

API

Description

Querying the Data Connection List

This API is used to query the data connection list.

Creating a Data Connection

This API is used to create a data connection.

Testing a Data Connection

This API is used to test a data connection.

Querying Information About a Data Connection

This API is used to query information about a data connection.

Updating a Data Connection

This API is used to update information about a data connection.

Deleting a Data Connection

This API is used to delete a data connection.

Instance Purchase

Table 3 Instance purchase

API

Description

Buying a DataArts Studio Instance

This API is used to buy a DataArts Studio instance.

Workspace Management

Table 4 Workspace management

API

Description

Obtaining the Workspace List

This API is used to obtain the workspace list.

Creating a Workspace

This API is used to create a workspace.

Obtaining Information About a Workspace

This API is used to obtain information about a workspace.

Instance Management

Table 5 Instance management

API

Description

Obtaining the Instance List

This API is used to obtain the instance list.

Workspace User Management

Table 6 Workspace user management

API

Description

Obtaining Workspace User Roles

This API is used to obtain workspace user roles.

Editing a Workspace User or User Group

This API is used to edit a workspace user or user group.

Obtaining Workspace User Information

This API is used to obtain workspace user information.

Adding a Workspace User

This API is used to add a workspace user.

Deleting a Workspace User

This API is used to delete a user from a workspace.

Data Source Metadata Acquisition

Table 7 Data source metadata acquisition

API

Description

Obtaining the Database List

This API is used to obtain the database list.

Obtaining Schemas

This API is used to obtain schemas. Only GaussDB(DWS) and RDS for PostgreSQL support schemas. Before calling this API, check whether the data source supports the **schema** field.

Obtaining Tables in a Data Source

This API is used to obtain tables in a data source.

Obtaining Table Fields in a Data Source

This API is used to obtain table fields in a data source.

Instance Specifications Change

Table 8 Instance specifications change

API

Description

Changing Specifications

This API is used to change specifications.