Publishing an API

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

View PDF

This section describes how to publish APIs in DataArts DataService.

Scenario

For the sake of security, APIs generated in DataArts DataService must be published before they can provide services.

Prerequisites

An API has been debugged.

Notes and Constraints

If one or more users publish APIs to the same exclusive cluster at the same time, the system displays message "Operation in progress. Try again later."

Procedure

On the DataArts Studio console, locate a workspace and click DataArts DataService.

In the left navigation pane, choose an edition, for example, Exclusive Edition. The Overview page is displayed.
In the navigation pane, choose API Development > APIs. Locate an API, click More in the Operation column, and select Publish.
In the displayed dialog box, select the target cluster.
Figure 1 Selecting a cluster
- In DataArts DataService Exclusive, the API is published to a DataArts DataService Exclusive cluster by default and can be published by version. After the API is published, it can be called through the intranet or Internet.
APIs must be reviewed and approved before they can be published. APIs are reviewed in the following way:
- An API publisher who does not have the reviewer permission must submit the API to the reviewer for review.
- An API publisher who has the reviewer permission can publish an API without review or approval.
An API submitted by a non-reviewer is published after it is approved by the reviewer.

NOTE:

The data connection of an API in the pending review state cannot be changed. It can be changed only when the application is rejected by a user with the workspace administrator role.

An admin, developer, or operator can be a reviewer. A viewer cannot be a reviewer.

Regardless of whether they are added as reviewers, users with the admin role of the workspace have the reviewer permissions by default.
After the API is published, you can go to the Service Catalogs page to view the API information.

Related Operations

Publishing APIs in batches: On the APIs page, select APIs, click Batch Operation above the list, and select Publish.

Figure 2 Batch operation

Parent topic: Developing APIs in DataArts DataService

Previous topic: Debugging an API

Next topic: Managing 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.

Chatbot