管理网关组
网关组可以将数据面实例组织成逻辑组,实现环境隔离(开发/预发布/生产)、团队隔离或按地理位置分组。每个网关组都有独立的配置作用域,并且可以运行不同版本的数据面。
本指南介绍如何使用企业版 API 创建、查看和更新网关组。
前置条件
- API7 企业版实例正在运行。
- 按照从控制台获取令牌中的步骤准备一个令牌。
创建网关组
可以创建新网关组,将网关实例归入同一逻辑组。
environment 决定组内数据面实例消耗哪一份许可证 CPU 核心数额度:production(默认值)或 non_production。详见核心数额度。API7 企业版从 3.10.5 版本开始支持;更早的版本会忽略该字段,所有网关组共用其唯一的核心数额度。
curl -k "https://localhost:7443/api/gateway_groups" -X POST \
-H "X-API-KEY: ${API_KEY}" \
-H "Content-Type: application/json" \
-d '{
"name": "docs-temp-group",
"description": "Docs validation gateway group",
"type": "api7_gateway",
"environment": "non_production",
"labels": {
"env": "docs-test"
}
}'
列出网关组
列出网关组可以查看所有现有逻辑组及其配置。
curl -k "https://localhost:7443/api/gateway_groups" \
-H "X-API-KEY: ${API_KEY}"
生成实例令牌
数据面实例需要令牌才能注册到网关组。每个网关组都可以生成自己的唯一令牌。
curl -k "https://localhost:7443/api/gateway_groups/{gateway_group_id}/instance_token" -X POST \
-H "X-API-KEY: ${API_KEY}"
更新网关组
可以更新现有网关组的名称、说明、环境和标签。不传 environment 时,网关组保持在当前的核心数额度上。
curl -k "https://localhost:7443/api/gateway_groups/{gateway_group_id}" -X PUT \
-H "X-API-KEY: ${API_KEY}" \
-H "Content-Type: application/json" \
-d '{
"name": "docs-temp-group-updated",
"description": "Updated docs validation group",
"environment": "production",
"labels": {
"env": "docs-test",
"team": "docs"
}
}'
验证配置
获取特定网关组的详细信息以验证配置。
curl -k "https://localhost:7443/api/gateway_groups/{gateway_group_id}" \
-H "X-API-KEY: ${API_KEY}"