Help Center/ DataArts Studio/ User Guide/ DataArts DataService/ Developing APIs in DataArts DataService/ Managing APIs/ Exporting All/Exporting/Importing APIs
Updated on 2024-10-23 GMT+08:00
View PDF
Share

Exporting All/Exporting/Importing APIs

Operation Scenario

DataArts DataService allows you to import and export (including exporting all) APIs to quickly copy or migrate existing APIs.

Constraints

  • To export all APIs, you must have the permissions of the Administrator or Tenant Administrator.
  • All the APIs of a workspace can be exported only once, and only one such export task can be executed within a minute.

Exporting All APIs

You can export all APIs based on the current filter criteria. You must have the permissions of the Administrator or Tenant Administrator.

  1. On the DataArts Studio console, 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. Choose API Development > APIs.
  4. Above the API list, choose More > Export All.
    • To export all APIs, you must have the permissions of the Administrator or Tenant Administrator.
    • All the APIs of a workspace can be exported only once, and only one such export task can be executed within a minute.

    In the displayed dialog box, click Yes to export all the APIs to an Excel file.

    Figure 1 Exporting all APIs
  5. Open the downloaded Excel file to view the exported APIs. APIs of different types are exported to different sheets.
    Figure 2 Exported Excel file

Exporting APIs

  1. On the DataArts Studio console, 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. Choose API Development > APIs.
  4. Select the target APIs, click More above the API list, and select Export.
  5. In the displayed dialog box, confirm the APIs to export and click Yes to export the APIs to an Excel file.
    Figure 3 Exporting APIs
  6. Open the downloaded Excel file to view the exported APIs. APIs of different types are exported to different sheets.
    Figure 4 Exported Excel file

Importing APIs

  1. On the DataArts Studio console, 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. Choose API Development > APIs.
  4. Click More above the API list and select Import.
  5. On the Import API page, set parameters and click Select. Select the API file to be imported and click Import. The import status is displayed in the Import Result area.
    Table 1 Parameters for importing APIs

    Parameter

    Description

    Publish

    Whether to publish the APIs to be imported. By default, the APIs are not published.

    • Import APIs only: The imported APIs are in unpublished state.
    • Import APIs and publish them to all clusters in the current workspace: The imported APIs will be published to all clusters in the current workspace. If there is no cluster, the imported APIs will not be published.

    Overwrite

    Whether to overwrite APIs with the same names as the APIs to be imported. By default, APIs are not overwritten.

    • No: If there is an API with the same name as an API to be imported, the API will not be imported.
    • Yes: If there is an API with the same name as an API to be imported, the existing API will be overwritten.

    Import File

    The API file can be one exported from another project or an Excel file edited based on the template specifications.
    Figure 5 Importing APIs

  6. After the APIs are imported successfully, you can view them in the API list.
Parent topic: Managing APIs