Help Center/ DataArts Studio/ API Reference/ API Overview/ DataArts DataService API Overview

Updated on 2024-11-06 GMT+08:00

View PDF

DataArts DataService API Overview

**Table 1** DataArts DataService API types
Type	Description
API Management	API management APIs
Application Management	Application management APIs
Message Management	Message management APIs
Authorization Management	Authorization management APIs
Service Catalog Management	Service catalog management APIs
Gateway Management	Gateway management APIs
App Management	App management APIs
Overview	Overview APIs
Cluster Management	Cluster management APIs.

API Management

**Table 2** API management
API	Description	Maximum API Requests in 10 Seconds	Maximum User Requests in 10 Seconds
Creating an API.	This API is used to create an API.	2400	120
Querying the API List	This API is used to query the API list.	2400	120
Updating an API	This API is used to update an API.	2400	120
Querying API Information	This API is used to query API information.	2400	120
Deleting APIs	This API is used to delete APIs.	2400	120
Publishing an API	This API is used to publish an API. Only published APIs can be called. You can choose to publish an API to a specified gateway.	2400	120
Performing an API Operation	This API is used to unpublish, stop, or recover an API. After the API is unpublished, its authorization will be canceled and the API cannot be called.	2400	120
Authorizing APIs (Exclusive Edition)	An app cannot access any APIs after being created. To enable an app to access an API, authorize the API to the app. After the authorization is successful, the app can access the API within the validity period.	2400	120
Debugging an API	This API is used to debug an API.	2400	120
Performing an API Authorization Operation	The API reviewer can initiate a request to authorize an API. After the authorization is successful, the app can access the API within the validity period. API authorization includes authorization and renewal.	2400	120
Querying API Publishing Messages in DataArts DataService Exclusive	This API is used to query the API publishing messages in different clusters.	2400	120
Querying Instances for API Operations in DataArts DataService Exclusive	This API is used to query instances for API operations.	2400	120
Querying API Debugging Messages in DataArts DataService Exclusive	This API is used to query the API debugging information in different clusters.	2400	120
Importing an Excel File Containing APIs	This API is used to import an Excel file that contains APIs.	2400	120
Exporting an Excel File Containing APIs	This API is used to export an Excel file that contains APIs.	2400	120
Exporting a .zip File Containing All APIs	This API is used to export a .zip file that contains all APIs.	2400	120
Downloading an Excel Template	This API is used to download an Excel template.	2400	120

Application Management

**Table 3** Application management
API	Description	Maximum API Requests in 10 Seconds	Maximum User Requests in 10 Seconds
Querying the Application List	This API is used to query the application list.	2400	120
Reviewing an Application	This API is used to review an application.	2400	120
Obtaining Application Details	This API is used to obtain the details of an application.	2400	120

Message Management

**Table 4** Message management
API	Description	Maximum API Requests in 10 Seconds	Maximum User Requests in 10 Seconds
Querying the Message List	This API is used to query the list of notification messages in the review center. Different from applications, notification messages cannot be rejected and can be processed only within a specified time period.	2400	120
Processing Messages	This API is used to process received notification messages within a specified time period.	2400	120
Obtaining Message Details	This API is used to obtain the details of a message. This function is only used for displaying application details and not for processing. Therefore, background parameters such as the ID are not displayed.	2400	120

Authorization Management

**Table 5** Authorization management
API	Description	Maximum API Requests in 10 Seconds	Maximum User Requests in 10 Seconds
Querying Apps Authorized to Call an API	This API is used to query the apps that have been authorized to call an API.	2400	120
Querying Authorized APIs of an App	This API is used to query authorized APIs of an app.	2400	120

Service Catalog Management

**Table 6** Service catalog management
API	Description	Maximum API Requests in 10 Seconds	Maximum User Requests in 10 Seconds
Obtaining the List of APIs and Catalogs in a Catalog	This API is used to obtain the list of APIs and catalogs in the current catalog. The list is displayed in the data format of the catalog.	2400	120
Obtaining the List of APIs in the Current Catalog	This API is used to obtain the list of APIs in a catalog.	2400	120
Obtaining the List of Sub-Catalogs in a Catalog	This API is used to obtain the list of sub-catalogs in a catalog. (The returned sub-catalogs are displayed on the same page. It is recommended that this API be used only in scenarios where pagination is not supported, for example, generating a catalog tree.)	2400	120
Updating a Service Catalog	This API is used to update a service catalog.	2400	120
Querying a Service Catalog	This API is used to query a service catalog.	2400	120
Creating a Service Catalog	This API is used to create a service catalog. The ID of the root directory is 0.	2400	120
Deleting Catalogs	This API is used to delete service catalogs.	2400	120
Moving a Catalog to Another Catalog	This API is used to move a catalog to another catalog.	2400	120
Moving APIs to Another Catalog	This API is used to move APIs to another catalog.	2400	120
Obtaining the ID Through the Path	This API is used to obtain the ID through the path.	2400	120
Obtaining the Path Through the ID	This API is used to obtain the path through the ID.	2400	120
Obtaining the Path to a Catalog Through Its ID	This API is used to obtain the path to a catalog through its ID.	2400	120
Querying the Service Catalog API List	This API is used to query the service catalog API list.	2400	120

Gateway Management

**Table 7** Gateway management
API	Description	Maximum API Requests in 10 Seconds	Maximum User Requests in 10 Seconds
Obtaining a Gateway Instance (Exclusive Edition)	This API is used to obtain a gateway instance (exclusive edition).	2400	120
Obtaining a Gateway Group	This API is used to obtain a gateway group.	2400	120

App Management

**Table 8** App management
API	Description	Maximum API Requests in 10 Seconds	Maximum User Requests in 10 Seconds
Creating an App	This API is used to create an app.	2400	120
Querying the App List	This API is used to query the app list.	2400	120
Updating an App	This API is used to update an app.	2400	120
Deleting an App	This API is used to delete an app.	2400	120
Querying App Details	This API is used to query the details of an app.	2400	120

Overview

**Table 9** Overview
API	Description	Maximum API Requests in 10 Seconds	Maximum User Requests in 10 Seconds
Querying the API Overview	This API is used to query the API overview.	2400	120
Querying the App Overview	This API is used to query the app overview.	2400	120
Querying Top N APIs Called	This API is used to query the top N APIs called.	2400	120
Querying Top N Apps Used	This API is used to query the top N apps used.	2400	120
Querying API Statistics Details	This API is used to query API statistics details.	2400	120
Querying App Statistics Details	This API is used to query app statistics details.	2400	120
Querying API Dashboard Data Details	This API is used to query API dashboard data details.	2400	120
Querying Data Details of a Specified API Dashboard	This API is used to query details of a specified API dashboard.	2400	120
Querying App Dashboard Data Details	This API is used to query app dashboard data details.	2400	120
Querying Top N APIs Called by a Specified App	This API is used to query top N APIs called by a specified app.	2400	120

Cluster Management

**Table 10** Cluster management
API	Description	Maximum API Requests in 10 Seconds	Maximum User Requests in 10 Seconds
Querying the Cluster Overview Information List	This API is used to query the cluster overview information list.	2400	120
Querying the List of Cluster Details	This API is used to query the list of cluster details.	2400	120
Querying Cluster Details	This API is used to query the details of a cluster.	2400	120
Querying the Access Log List of a DataArts DataService Cluster	This API is used to query the access log list of a DataArts DataService cluster.	2400	120
Enabling Log Dump to OBS for DataArts DataService Clusters	This API is used to enable log dump to OBS for DataArts DataService clusters.	2400	120
Enabling Log Dump to LTS for DataArts DataService Clusters	This API is used to enable log dump to LTS for DataArts DataService clusters.	2400	120

Parent Topic: API Overview

Previous topic: DataArts Quality API Overview

Next topic: Calling APIs

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.