更新时间:2024-10-18 GMT+08:00

全量导出/导出/导入API

操作场景

数据服务支持全量导出/批量导出/导入API,可以快速复制或迁移现有的API。

约束限制

  • 全量导出必须具备 AdministratorTenant Administrator权限。
  • 每个工作空间每分钟仅能全量导出一次,同时只能有一个全量导出任务执行。

全量导出API

全量导出时会将全量API按照当前的筛选条件进行导出,须具备 AdministratorTenant Administrator权限。

  1. DataArts Studio控制台首页,选择对应工作空间的“数据服务”模块,进入数据服务页面。
  2. 在左侧导航栏选择服务版本(例如:专享版),进入总览页。
  3. 单击开发API > API管理页面,进入API管理页面。
  4. 在API列表上方,选择更多 > 全量导出,弹出导出确认窗口。
    • 全量导出必须具备 AdministratorTenant Administrator权限。
    • 每个工作空间每分钟仅能全量导出一次,同时只能有一个全量导出任务执行。

    在导出窗口中单击“确认”导出全量API,单击确认即可以Excel文件的形式导出API。

    图1 全量导出API
  5. 打开下载到本地的Excel文件,可以查看导出的API。不同类型的API会分别导出到文件页签中,单击下方页签可以切换查看并编辑。
    图2 Excel文件样式

导出API

  1. DataArts Studio控制台首页,选择对应工作空间的“数据服务”模块,进入数据服务页面。
  2. 在左侧导航栏选择服务版本(例如:专享版),进入总览页。
  3. 单击开发API > API管理页面,进入API管理页面。
  4. 勾选待导出的API所在行,在API列表上方,选择更多 > 导出,弹出导出窗口。
  5. 在导出窗口中确认待导出的API,单击确认即可以Excel文件的形式导出API。
    图3 导出API
  6. 打开下载到本地的Excel文件,可以查看导出的API。不同类型的API会分别导出到文件页签中,单击下方页签可以切换查看并编辑。
    图4 Excel文件样式

导入API

  1. DataArts Studio控制台首页,选择对应工作空间的“数据服务”模块,进入数据服务页面。
  2. 在左侧导航栏选择服务版本(例如:专享版),进入总览页。
  3. 单击开发API > API管理页面,进入API管理页面。
  4. 在API列表上方,选择更多 > 导入,进入导入API页面。
  5. 在导入页面中配置导入参数后,单击“选择Excel文件”,选择待导入的API文件后单击导入,导入结果中可以展示导入状态。
    表1 导入参数配置说明

    参数

    说明

    是否发布

    配置导入的API是否需要发布,默认不发布。

    • 仅导入API:仅导入API,导入后的API为“未发布”状态。
    • 导入API并发布到当前空间所有集群:导入API,并发布到当前工作空间的所有集群上。如果没有集群,则不发布只导入。

    是否覆盖

    配置导入的重名API是否需要更新,默认不更新。

    • 不覆盖:如果已存在同名API,则不导入该API。
    • 当导入API与原有API定义冲突时,覆盖原有API定义:如果存在同名API,则按照导入的API更新API定义。

    导入文件

    待导入的API文件可以是从其他项目直接导出的API文件,也可以是通过模板填写的Excel文件,需要确保符合模板规范要求。

    图5 导入API

  6. 导入成功后,即可在API列表中查看导入的API。