文档中心
登录
注册
API 网关
文档指南
API 网关
API 网关
文档指南
请输入
产品动态
新功能发布记录
产品公告
【产品变更】API 网关正式商业化公告
【产品变更】API 网关支持华南1 （广州）地域
【产品变更】API 网关支持华东 2（上海）地域
【产品变更】API 网关正式公测公告
产品简介
什么是 API 网关
产品优势
产品功能
应用场景
基本概念
地域和可用区
使用限制
性能说明
产品计费
计费概述
欠费说明
税费和发票
快速入门
新手指引
使用 API 网关发布容器服务集群中部署的应用
使用 API 网关发布微服务引擎注册中心管理的应用
使用 API 网关发布云服务器中部署的应用
使用 API 网关发布函数服务中的函数
用户指南
实例管理
创建实例
添加访问入口
管理实例
版本管理
服务管理
创建服务
绑定自定义域名
添加 CNAME 记录
管理服务
路由管理
路由概述
创建 Upstream 流量分发路由
创建 Mock 路由
创建重定向路由
路由策略
配置超时策略
配置跨域策略
配置重写策略
配置重试策略
配置流量镜像策略
管理路由
Upstream 管理
Upstream 概述
Upstream 来源
导入容器集群
导入注册集群
集群路由同步
管理容器集群
导入注册中心
管理注册中心
容器服务类型 Upstream
创建容器服务类型 Upstream
创建 VCI Agent Sandbox 服务类型 Upstream
管理容器服务类型 Upstream 版本
网关支持的 Annotation
注册中心类型 Upstream
创建注册中心类型 Upstream
管理注册中心类型 Upstream 版本
函数服务类型 Upstream
云服务器类型 Upstream
固定域名类型 Upstream
固定 IP 类型 Upstream
管理 Upstream
服务熔断策略
消费者管理
消费者概览
创建消费者
管理消费者
生成认证信息
监控与告警
监控管理
实例监控
服务监控
监控指标
告警管理
告警管理概述
一键开启告警
基于模板创建告警规则
手动创建告警规则
日志管理
标签与项目
标签管理
项目管理
插件中心
安全与认证概述
认证鉴权
HMAC 认证鉴权
API Key 认证鉴权
外部认证鉴权
OAuth2 单点登录插件
JWT 认证鉴权
IAM 访问鉴权
流量管控
访问限流
LLM 负载感知路由
LLM Session 亲和路由插件
MCP 会话保持插件
全局限流插件
LLM 会话保持 ID 生成插件
传输协议
GEOIP 插件
安全防护
IP 黑白名单
自定义插件
创建 Lua 插件
创建 WASM 插件
管理自定义插件
AI 网关
什么是 AI 网关
AI 网关服务
MCP 服务
AI 多模型代理
AI 模型 Fallback
最佳实践
使用 HMAC 实现网关认证鉴权
使用 API Key 实现网关认证鉴权
JWT Token 迁移 API Key 最佳实践（不保留 JWT Token）
JWT Token 迁移 API Key 最佳实践（保留 JWT Token）
使用控制台实现容器服务应用的蓝绿发布和灰度发布
使用 Annotation 实现容器服务应用的蓝绿发布和灰度发布
通过控制台实现 Nacos 蓝绿部署和灰度发布
API 网关结合 GTM 实现跨地域流量调度与容灾切换
使用 API 网关实现多集群南北流量管理
通过 API 网关使用 Gateway API
基于 API 网关访问 VCI Agent Sandbox
基于 API 网关实现多时间窗口的 Token 限流
常见问题
常规 FAQ
自动生成的访问域名会一直不变吗？
调用 API 网关服务 FAQ
请求返回 404 Not Found 如何处理？
请求返回 403 Forbidden 如何处理？
请求返回 503 Service unavailable 如何处理？
请求返回 504 Service unavailable 如何处理？
服务未开启认证，访问请求中携带 JWT Token 信息时会返回 Token 错误，如何处理？
API 网关默认会将 Header 转换为小写
集群管理 FAQ
导入集群报错
AI 网关 FAQ
使用 AI 代理返回 upstream connect error 如何处理？
API 参考
API 发布历史
API 列表
调用方式
请求结构
服务地址
公共参数
签名机制
返回结构
网关管理
CreateGateway - 创建网关
UpdateGateway - 更新网关监控配置
UpdateGatewaySpec - 更新网关规格配置
UpdateGatewayLog - 更新网关日志配置
UpdateGatewayCustomLog - 更新网关自定义日志配置
UpdateGatewayTrace - 更新网关链路追踪配置
GetGateway - 查询网关详情
ListGateways - 查询网关列表
DeleteGateway- 删除网关
CheckGatewayExist - 检查网关是否存在
AttachGatewayLB - 新增访问入口
DetachGatewayLB - 解绑访问入口
ListGatewayLBs - 批量查询网关访问入口
GetGatewayParameters - 查询网关下游连接缓冲区大小
UpdateGatewayDownstreamConnectionBufferLimits - 更新网关下游连接缓冲区大小
GetGatewayAvailableZones - 查询当前 Region 可用区列表
路由管理
CreateGatewayService - 创建服务
UpdateGatewayService - 更新服务
GetGatewayService - 查询服务详情
ListGatewayServices - 批量查询服务
DeleteGatewayService - 删除服务
CheckGatewayServiceExist - 检查服务是否存在
CreateCustomDomain- 创建自定义域名
UpdateCustomDomain - 更新自定义域名
GetCustomDomain - 查询自定义域名详情
ListCustomDomains - 批量查询自定义域名
DeleteCustomDomain - 删除自定义域名
CheckCustomDomainExist - 检查自定义域名是否存在
GetJwtToken - 查询 JWT Token
CreateRoute - 创建路由
UpdateRoute - 更新路由
GetRoute - 查询路由详情
ListRoutes - 批量查询路由
DeleteRoute - 删除路由
CheckRouteExist - 检查路由是否存在
后端管理
CreateUpstream - 创建 Upstream
UpdateUpstream - 更新 Upstream
GetUpstream - 查询 Upstream 详情
ListUpstreams - 批量查询查询 Upstream
DeleteUpstream - 删除 Upstream
CheckUpstreamExist - 检查 Upstream 是否存在
CreateUpstreamSource - 创建 Upstream 来源
UpdateUpstreamSource - 更新 Upstream 来源
GetUpstreamSource - 查询 Upstream 来源详情
ListUpstreamSources - 批量查询Upstream来源
DeleteUpstreamSource - 删除 Upstream 来源
CreateUpstreamVersion - 创建 Upstream 版本
UpdateUpstreamVersion - 更新 Upstream 版本
DeleteUpstreamVersion - 删除 Upstream 版本
CheckUpstreamVersionExist - 检查 Upstream 版本是否存在
CheckUpstreamSpecExist - 检查 Upstream 后端服务是否存在
消费者管理
CreateConsumer - 创建消费者
UpdateConsumer - 更新消费者
GetConsumer - 查询消费者详情
ListConsumers - 批量查询消费者
DeleteConsumer - 删除消费者
CheckConsumerExist - 检查消费者是否存在
CheckConsumerUsed - 检查消费者是否被使用
CreateConsumerCredential - 创建消费者凭证
ListConsumerCredentials - 批量查询消费者凭证
DeleteConsumerCredential - 删除消费者凭证
CheckConsumerCredentialExist - 检查消费者凭证是否存在
插件管理
CreatePluginBinding - 创建插件绑定关系
UpdatePluginBinding - 更新插件绑定关系
GetPluginBinding - 查询插件绑定详情
ListPluginBindings - 批量查询插件绑定关系
DeletePluginBinding - 删除插件绑定关系
CreatePlugin - 创建插件
UpdatePlugin - 更新插件
DeletePlugin - 删除插件
GetPlugin - 查询插件详情
公共错误码
相关协议
微服务治理产品/服务专用条款
API 网关服务等级协议
文档首页
API 网关
常见问题
集群管理 FAQ
常见问题
集群管理 FAQ
导入集群报错
