Overview

Updated on 2025-02-18 GMT+08:00

View PDF

DataArts Studio DataArts DataService aims to build a unified data service bus for enterprises to centrally manage internal and external API services. DataArts DataService helps you quickly generate data APIs based on data tables and allows you manage the full lifecycle of APIs, covering API publishing, management, and O&M. With DataArts DataService, you can implement microservice aggregation, frontend-backend separation, and system integration, and provide functions and data for partners and developers easily and quickly at a low cost and risk.

DataArts DataService has the following advantages over other data sharing and exchange methods:

Unified interface standards reduce the workload for interconnection with upper-layer applications.
Data logic is deployed on the data platform and is therefore decoupled from the application logic. This reduces repeated development of data models and avoids frequent changes caused by data logic adjustment.
Data logic-related storage and compute resources are deployed on the data platform, reducing resource consumption on applications.
A large amount of detailed and sensitive data is inaccessible to applications. In addition, DataArts DataService improves data security by means of API review and publishing, authentication and throttling, and dynamic anonymization.

DataArts DataService encapsulates data logic into RESTful APIs of a unified standard that can be used to access data. DataArts DataService applies to quick response to the requests for accessing a small amount of data. To open a large amount of data, you are advised to adopt data sharing and exchange or other solutions.

Publishing an API

To publish an API or a group of APIs, do as follows:

Buying and Managing an Exclusive Cluster
If you want to use DataArts DataService, you must buy a DataArts DataService Exclusive cluster.
Creating a Reviewer in DataArts DataService
Before creating an API, you need to create a reviewer.
Creating an API
You can generate an API. An API can be generated using configuration or a script/MyBatis.
Debugging an API
Debug the created API on the management console to check whether it runs properly.
Publishing an API
The API can be called only after it is published.
Managing APIs
You can manage the published API as needed.
Orchestrating an API
API orchestration allows you to reorganize and reconstruct APIs in a visualized manner based on specific service logic and processes without compiling code. In this way, you can perform secondary development easily without affecting native APIs.
(Optional) Configuring a Throttling Policy
To ensure the stability of backend services, you can perform throttling on the API.
(Optional) Authorizing an API
An app defines the identity of an API caller. An API that uses app or IAM authentication must be authorized so that the authentication information for calling the API can be obtained.

Calling an API

To call an API, perform the following operations:

Obtain an API.
Obtain the API from the service catalog. An API can be called only after it is published.
Applying for API Authorization
If you are an API developer and want to call an API which uses app or IAM authentication, you must apply for API authorization.
Calling the API.
After completing the preceding steps, you can call the API.

Overview Page

On the Overview page, you can view various monitoring data views. The Overview page displays Develop APIs and Call APIs.

Figure 1 Develop APIs tab page

**Table 1** Parameters on the Develop APIs tab page
Parameter	Description
APIs Published	The number of APIs published every day, week, month, and year.
APIs Called	The number of times that APIs are called in half a day, every day, every week, and every month.
Top 5 (1)	The call rate of APIs, including the success rate, failure rate, validity rate, and invalidity rate.
Top 5 (2)	The calling duration of APIs, average duration, success duration, and failure duration.
Top 5 APIs by Call Quantity	The top 5 APIs that are called, successful API calls, failed API calls, valid API calls, and invalid API calls.
Top 5 by Call Quantity	The top 5 APIs that are called, successful API calls, failed API calls, valid API calls, and invalid API calls.
Published	The number of APIs that have been published.
Developing	The number of APIs that are being developed.
Applications	The number of APIs that are requested by applications.
Successful	The number of successful API calls.
Failed	The number of failed API calls.
Total	The total number of API calls.

Figure 2 Call APIs tab page

**Table 2** Parameters on the Call APIs tab page
Parameter	Description
APIs Called	The number of API calls made every day, week, month, and year.
Top 5	The ratio of successful and failed API calls in the last seven days.
Completed	The number of APIs applied on the DataArts DataService platform.
Successful	The number of successful API calls on the DataArts DataService platform.
Total	The number of total API calls on the DataArts DataService platform.

Parent topic: DataArts DataService

Previous topic: DataArts DataService

Next topic: Specifications

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.

Chatbot