全部产品
Search
文档中心

API 网关:API网关分组同步

更新时间:Jul 14, 2022

本功能主要是帮助您在不同API分组之间实现API定义的快速同步。在开始同步前,建议先了解同步范围,以及需要做的一些工作。

1. API分组同步范围

API分组同步功能的同步范围包括

  • API分组下所选API的配置信息。

API分组无法同步的数据包括:

  • API分组信息,即API分组管理里面的所有配置信息,包括公网二级域名、VPC内网域名、HTTPS安全策略、绑定的独立域名、环境变量等;

  • API信息,包括API授权信息、已绑插件、发布历史、监控信息、安全信息、云市场商品配置信息等;

  • openId connect 认证的API,不会同步OpenID Connect 的认证信息;

  • 模型信息

    • API 比较过程中,会根据API引用的模型名称判断API定义是否一致,不会检查引用模型的具体定义是否一致;

    • 若源分组API使用了模型,目标分组不存在同名模型,则模型自动同步到目标分组;

    • 若目标分组API存在源分组API引用的同名模型,源分组该模型的具体定义不会同步到目标分组;

  • 分组定义的环境变量不会同步到目标分组;

  • 要向一个新的API分组进行同步,请您先创建分组,点击进行创建;

注意

在同步过程中,请不要修改这些同步的API定义,避免造成数据混乱。

2. 分组同步

  1. 登录API网关控制台,在左侧栏点击开放API,选择分组管理,点击分组API配置同步

  2. 同步前准备,可参考第一章节,确认已了解内容后点击进入下一步。

同步前准备
  1. 选择分组。选择API源分组、目标分组以及想要同步的API版本。目前支持同步的版本分别是当前编辑版本、测试环境的最新版本、预发环境的最新版本、线上环境的最新版本。

说明

当前编辑版本指的是分组内所有API最新保存的API定义,无论这个API是否有发布。

选择分组
  1. API差异对比。可以对比的指标如下:

  • 新增API:源分组中有,而目标分组没有的API;

  • 仅VPC后端信息不一致API:其他定义一致,仅VPC后端配置信息不一致的API;

  • 定义不一致API:定义不一致的API,不包括仅VPC后端配置信息不同且其他定义一致的情况;

  • 缺失API:目标分组中存在,但源分组中不存在的API,此类API不在同步范围内;

  • 定义一致API:定义一致的API,此类API不在同步范围内。

说明
  • 若同步的API较多,可使用跨页选中所有API按钮进行批量选中。

  • 分组定义的环境变量检查结果仅供查看,但不会同步到目标分组。

    API差异对比
  1. 修改VPC后端。页面列出所有的API都会同步,可以选中想要修改vpc后端的API进行批量修改。修改后点击开始同步,数据就会开始同步。

说明

后端为vpc类型的API可以勾选,其他类型API无法勾选。

修改vpc后端
  1. 开始同步并查看同步结果。

分组同步详情

3. 查看分组同步历史

登录API网关控制台,在左侧栏点击开放API,选择分组管理,点击分组同步记录,即可查看分组同步的历史记录,并可以点击操作栏查看分组同步的详细信息。

分组同步记录