Suspending/Restoring an API

Scenarios

To edit or debug a published API, you must suspend the API first. After the API is suspended, its original authorization information is retained. You can edit and debug the API.

You can restore the API so that it can continue to provide services.

The suspended API cannot be accessed in the specified time, which may affect the applications or users who are using the API. Ensure that users have been notified of this consequence.

Prerequisites

• An API has been created.
• An API has been published in the environment.

Suspending an API

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

2. In the left navigation pane, choose an edition, for example, Exclusive Edition. The Overview page is displayed.
3. Choose API Development > APIs.
4. Locate the row that contains the API to be suspended, click More in the Operation column, and select Suspend.
5. In the displayed dialog box, select the time period when the API needs to be suspended and click OK.
   

   The API suspension time must be later than its minimum retention period. Authorized users will be notified of the suspension. If all authorized users process the notifications in the review center or unbind the API from their apps, the API will be directly suspended. Otherwise, the API will be forcibly suspended when the minimum retention period ends.

Restoring an API

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

2. In the left navigation pane, choose an edition, for example, Exclusive Edition. The Overview page is displayed.
3. Locate the row that contains the API to be restored, click More in the Operation column, and select Restore.