Publishing an API

Scenario

For security purposes, APIs generated and registered in DataArts DataService must be published to service catalogs so that they can provide services.

Procedure

1. On the DataArts Studio console, locate an instance and click Access. On the displayed page, locate a workspace and click DataArts DataService.

2. In the left navigation pane, choose an edition, for example, Exclusive Edition. The Overview page is displayed.
3. On the displayed page, choose APIs from the left navigation bar. In the Operation column, choose More > Publish.
4. On the confirmation page, you can click More to view publish details.
   Figure 1 Publish
   
   • In DataArts DataService Exclusive, the API is published to a DataArts DataService Exclusive cluster by default. After the API is published, it can be called through the intranet. You can also publish the API to an APIG Exclusive instance.
     • APIG Exclusive: To publish an API to APIG Exclusive, you must buy an APIG instance on the APIG console in advance. After the instance is created, a default API group is available. The system automatically assigns a debugging domain name for internal tests to the API group. This debugging domain name is unique and cannot be changed, and it can be accessed for a maximum of 1,000 times each day. If you want to create an API group exclusively for DataArts DataService APIs, see Creating an API Group. In addition, you can bind one or more independent domain names to an API group. For details, see Binding a Domain Name. The domain names can be used to call APIs for more than 1,000 times each day.
5. 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. By default, a workspace administrator has the reviewer permission.

   An API submitted by a non-reviewer is published after it is approved by the reviewer.

Follow-up Operations

After the API is published, you can go to the Service Catalogs page to view the API information.

You can also manage APIs. For details, see Managing APIs. Alternatively, you can choose Operations Management > Throttling Policies and configure throttling for the API. For details, see Creating Throttling Policies.