Help Center/ DataArts Studio/ User Guide/ DataArts DataService/ Developing APIs in DataArts DataService/ Publishing an API
Updated on 2026-05-20 GMT+08:00
View PDF
Share

Publishing an API

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

  1. On the DataArts Studio console, locate a workspace and click DataArts DataService.
  1. In the left navigation pane, choose an edition, for example, Exclusive Edition. The Overview page is displayed.
  2. In the navigation pane, choose API Development > APIs. Locate an API, click More in the Operation column, and select Publish.

    You can also test the API on the creation, editing, and debugging pages and click Publish.

  3. 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.
  4. 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.

    The data connection of an API pending review can be changed only after the reviewer rejects the review application or the applicant cancels the application.

    • Only workspace administrators and developers can be added as reviewers. O&M personnel and visitors cannot be added as reviewers.
    • By default, the workspace administrator does not have the review permission. If you want to have the review permission, you can add yourself as a reviewer.
  5. 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 on the Exclusive Edition console, select APIs, click Batch Operation above the list, and select Publish.

Figure 2 Batch operation