跳到主要内容
版本:3.2.16.5

ADC 命令参考

API Declarative CLI(ADC)是一个命令行工具,用于声明式地管理 APISIX 和 API7 企业版。它可以简洁清楚地定义网关的期望状态,让开发人员和管理员专注于结果。

声明式配置是唯一的可信来源。开发人员可以通过现有的版本控制系统管理这些配置。

ADC 的通用语法如下。

adc [command] [options]

可用的全局选项如下。

  • -V, --version 用于查看版本。
  • -h, --help 用于显示命令帮助。

配置 ADC​

使用 ADC 管理网关前,需要先通过环境变量或命令行参数完成配置。

使用环境变量​

ADC 的所有配置选项都可以通过环境变量设置。例如,分别使用 ADC_BACKEND 和 ADC_SERVER 配置后端类型和地址。

export ADC_BACKEND=api7ee
export ADC_SERVER=https://localhost:7443

更方便的方式是在 .env 文件中配置这些选项。

.env
ADC_BACKEND=api7ee
ADC_SERVER=https://localhost:7443

使用命令行参数​

你也可以使用命令行参数配置 ADC 或覆盖环境变量中的配置。例如,以下命令可以设置或覆盖 ping 命令的后端类型和地址。

adc ping --backend api7ee --server "https://localhost:7443"

运行 adc help [command] 查看指定命令可用的配置选项。

命令​

adc ping​

检查与所配置后端的连通性。

选项默认值说明有效值环境变量
--verbose <integer>1覆盖日志详细程度。0 表示无日志,1 表示基本日志,2 表示调试日志。0、1 或 2
--backend <backend>apisix要连接的后端类型。apisix 或 api7eeADC_BACKEND
--server <string>http://localhost:9180后端服务器地址。ADC_SERVER
--token <string>用于访问后端的 API Token。ADC_TOKEN
--gateway-group <string>default要操作的网关组。ADC_GATEWAY_GROUP
--label-selector <selectors>用于筛选资源的标签。
--include-resource-type <string>按资源类型筛选,仅保留指定类型的资源。
--exclude-resource-type <string>按资源类型筛选,排除指定类型的资源。
--timeout <duration>10s客户端连接后端 Admin API 的请求超时时长,例如 30s、10m 或 1h10m。
--ca-cert-file <string>用于验证后端 Admin API 的 CA 证书路径。ADC_CA_CERT_FILE
--tls-client-cert-file <string>用于验证后端 Admin API 的双向 TLS 客户端证书路径。ADC_TLS_CLIENT_CERT_FILE
--tls-client-key-file <string>用于验证后端 Admin API 的双向 TLS 客户端密钥路径。ADC_TLS_CLIENT_KEY_FILE
--tls-skip-verifyfalse连接后端 Admin API 时是否验证 TLS 证书。ADC_TLS_SKIP_VERIFY

使用示例​

检查与已配置后端的连通性​
adc ping
检查与指定后端的连通性​
adc ping --backend api7ee --server https://localhost:7443

adc lint​

在本地验证指定的配置文件。

选项默认值说明有效值环境变量
-f, --file <file-path>要检查的文件。

使用示例​

检查指定的配置文件​
adc lint -f adc.yaml
检查多个配置文件​
adc lint -f service-a.yaml -f service-b.yaml

adc sync​

将本地配置同步到已连接的后端。

选项默认值说明有效值环境变量
--verbose <integer>1覆盖日志详细程度。0 表示无日志,1 表示基本日志,2 表示调试日志。0、1 或 2
--backend <backend>apisix要连接的后端类型。apisix 或 api7eeADC_BACKEND
--server <string>http://localhost:9180后端服务器地址。ADC_SERVER
--token <string>用于访问后端的 API Token。ADC_TOKEN
--gateway-group <string>default要操作的网关组。ADC_GATEWAY_GROUP
--label-selector <selectors>用于筛选资源的标签。
-f, --file <file-path>要同步的配置文件。
--include-resource-type <string>按资源类型筛选,仅保留指定类型的资源。
--exclude-resource-type <string>按资源类型筛选,排除指定类型的资源。
--timeout <duration>10s客户端连接后端 Admin API 的请求超时时长,例如 30s、10m 或 1h10m。
--ca-cert-file <string>用于验证后端 Admin API 的 CA 证书路径。ADC_CA_CERT_FILE
--tls-client-cert-file <string>用于验证后端 Admin API 的双向 TLS 客户端证书路径。ADC_TLS_CLIENT_CERT_FILE
--tls-client-key-file <string>用于验证后端 Admin API 的双向 TLS 客户端密钥路径。ADC_TLS_CLIENT_KEY_FILE
--tls-skip-verifyfalse连接后端 Admin API 时是否验证 TLS 证书。ADC_TLS_SKIP_VERIFY

使用示例​

同步单个文件中的配置​
adc sync -f adc.yaml
同步多个文件中的配置​
adc sync -f service-a.yaml -f service-b.yaml
将配置同步到指定网关组​
adc sync -f adc.yaml --gateway-group production
跳过配置检查并同步配置​
adc sync -f adc.yaml --no-lint
同步配置并输出调试日志​
adc sync -f adc.yaml --verbose 2
将配置同步到指定后端​
adc sync -f service-a.yaml -f service-b.yaml --backend api7ee --server https://localhost:7443
仅同步配置文件中指定类型的资源​
adc sync -f adc.yaml --include-resource-type global_rule --include-resource-type plugin_metadata
仅同步带有指定标签的资源​
adc sync -f adc.yaml --label-selector app=catalog

adc dump​

将后端配置保存到本地文件。

选项默认值说明有效值环境变量
--verbose <integer>1覆盖日志详细程度。0 表示无日志,1 表示基本日志,2 表示调试日志。0、1 或 2
--backend <backend>apisix要连接的后端类型。apisix 或 api7eeADC_BACKEND
--server <string>http://localhost:9180后端服务器地址。ADC_SERVER
--token <string>用于访问后端的 API Token。ADC_TOKEN
--gateway-group <string>default要操作的网关组。ADC_GATEWAY_GROUP
--label-selector <selectors>用于筛选资源的标签。
-o, --output <file-path>保存后端数据的文件路径。
--include-resource-type <string>按资源类型筛选,仅保留指定类型的资源。
--exclude-resource-type <string>按资源类型筛选,排除指定类型的资源。
--timeout <duration>10s客户端连接后端 Admin API 的请求超时时长,例如 30s、10m 或 1h10m。
--ca-cert-file <string>用于验证后端 Admin API 的 CA 证书路径。ADC_CA_CERT_FILE
--tls-client-cert-file <string>用于验证后端 Admin API 的双向 TLS 客户端证书路径。ADC_TLS_CLIENT_CERT_FILE
--tls-client-key-file <string>用于验证后端 Admin API 的双向 TLS 客户端密钥路径。ADC_TLS_CLIENT_KEY_FILE
--tls-skip-verifyfalse连接后端 Admin API 时是否验证 TLS 证书。ADC_TLS_SKIP_VERIFY

使用示例​

将后端配置保存到默认文件 adc.yaml​
adc dump
将后端配置保存到指定文件​
adc dump -o service-configuration.yaml
仅保存后端中指定类型的资源​
adc dump --include-resource-type global_rule --include-resource-type plugin_metadata
仅保存带有指定标签的资源​
adc dump --label-selector app=catalog
保存指定后端的配置​
adc dump -o api7ee-dump.yaml --backend api7ee --server https://localhost:7443

adc diff​

显示本地文件与后端之间的配置差异。

选项默认值说明有效值环境变量
--verbose <integer>1覆盖日志详细程度。0 表示无日志,1 表示基本日志,2 表示调试日志。0、1 或 2
--backend <backend>apisix要连接的后端类型。apisix 或 api7eeADC_BACKEND
--server <string>http://localhost:9180后端服务器地址。ADC_SERVER
--token <string>用于访问后端的 API Token。ADC_TOKEN
--gateway-group <string>default要操作的网关组。ADC_GATEWAY_GROUP
--label-selector <selectors>用于筛选资源的标签。
-f, --file <file-path>要比较的配置文件。
--include-resource-type <string>按资源类型筛选,仅保留指定类型的资源。
--exclude-resource-type <string>按资源类型筛选,排除指定类型的资源。
--timeout <duration>10s客户端连接后端 Admin API 的请求超时时长,例如 30s、10m 或 1h10m。
--ca-cert-file <string>用于验证后端 Admin API 的 CA 证书路径。ADC_CA_CERT_FILE
--tls-client-cert-file <string>用于验证后端 Admin API 的双向 TLS 客户端证书路径。ADC_TLS_CLIENT_CERT_FILE
--tls-client-key-file <string>用于验证后端 Admin API 的双向 TLS 客户端密钥路径。ADC_TLS_CLIENT_KEY_FILE
--tls-skip-verifyfalse连接后端 Admin API 时是否验证 TLS 证书。ADC_TLS_SKIP_VERIFY

使用示例​

比较指定文件与后端的配置​
adc diff -f adc.yaml
比较多个文件与后端的配置​
adc diff -f service-a.yaml -f service-b.yaml
比较指定文件与指定后端的配置​
adc diff -f service-a.yaml -f service-b.yaml --backend api7ee --server https://localhost:7443

adc convert​

将 API 规范转换为 ADC 配置。

选项默认值说明有效值环境变量
openapi将 OpenAPI 规范转换为 ADC 配置。

使用示例​

将 YAML 格式的 OpenAPI 规范转换为 ADC 配置并保存到默认文件 adc.yaml​
adc convert openapi -f openapi.yaml
将 JSON 格式的 OpenAPI 规范转换为 ADC 配置并保存到指定文件​
adc convert openapi -f openapi.json -o converted-adc.yaml

更多信息请参阅 OpenAPI 转换参考。

adc help​

显示通用帮助或指定命令的帮助。

使用示例​

adc help [command]