跳到主要内容
版本：3.10.x

ADC 参考

API 声明式 CLI（ADC）可以从本地 YAML 或 JSON 文件管理 API7 网关配置。

有关安装、命令用法、配置格式、OpenAPI 转换和其他参考内容，请参阅 ADC 文档。如需比较 ADC 与其他 API7 网关管理方式，请参阅管理方式。

将配置作为代码管理​

当网关配置需要通过代码而不是逐项在控制台中编辑或调用 Admin API 进行管理时，可以使用 ADC。ADC 使用描述网关期望状态的本地声明式文件，在应用变更前将文件内容与运行中的网关进行比较。

这种工作流可以帮助团队：

  • 通过版本控制审查和审计网关配置变更。
  • 在不同网关组或环境中复用同一份配置。
  • 在同步前预览创建、更新和删除操作。
  • 导出现有网关组配置，作为后续变更的基线。

对于通过 CI/CD 流水线管理网关配置的团队，ADC 尤其适用。

ADC 如何与 API7 网关协作​

ADC 连接 API7 网关控制面，并将声明式配置应用到网关组。这样，团队可以通过文件管理路由、服务、上游、消费者、插件和其他网关资源，无需在控制台中手动修改配置或调用 Admin API。

应用变更前，ADC 可以检查本地文件、请求后端校验资源，并显示本地期望状态与运行中网关之间的差异，便于在变更进入 API7 网关前完成审查。

协调范围与所有权​

adc sync 可能删除处于同步范围内、但本地文件中不存在的远程资源。请选择预期的网关组，运行 adc diff，并在同步前审查生成的 diff.yaml。有关当前的范围控制行为，请参阅 ADC 工作流和标签选择器指南。

默认情况下，ADC 会在执行 diff、validate 和 sync 前，在本地配置中添加或覆盖 managed-by: adc 标签。因此，首次比较现有资源时可能只显示标签变更。此标签用于标识由 ADC 管理的资源，但不会限制协调范围。如果必须保持 managed-by 标签不变，请使用 --no-managed-by-label。

有关 API7 网关连接配置之外的详细内容，请参阅 ADC 文档。