欢迎使用腾讯云云原生智能网关(Cloud Native Intelligent Gateway,以下简称云原生智能网关)。
云原生智能网关是腾讯云推出的新一代网关产品,包含云原生网关和 AI 网关两大产品线,为企业提供全场景、智能化的流量治理解决方案。云原生网关作为基础架构核心,提供流量网关、微服务网关、安全网关能力;AI 网关面向智能化场景,提供大模型网关和多模型统一接入与智能调度、MCP 网关与传统应用 AI 化改造与协议转换能力。
云原生智能网关向用户提供实例管理、服务路由、插件管理、证书管理、弹性伸缩、模型服务管理、消费者管理等全栈网关能力。用户可以使用本文档介绍的 API,并参照相应的示例,对云原生智能网关进行相关操作:如创建网关实例、配置服务与路由、管理模型服务、授权消费者等;支持的全部操作可参见 API 概览。
请确保在使用这些接口前,已充分了解了云原生智能网关产品概述。
注意:
- 本章节云原生智能网关 API 接口均为最新 API 3.0 接口,后续云原生智能网关相关新增功能都会在此章节更新。我们强烈推荐您使用最新 API 3.0 接口。
- 现有旧版 API 接口功能依然保持,未来可能停止维护,如您仍需使用旧版接口可参考相关文档。
术语表
本文档涉及的一些常用术语如下:
| 术语 | 英文 | 说明 |
|---|---|---|
| 网关实例 | Gateway Instance | 一个独立的云原生网关运行单元,由腾讯云托管,包含网关节点和管控能力。 |
| 集群分组 | Cluster Group | 将网关节点按业务特性划分为多套集群分组进行管理,可配置多接入点(CLB)。 |
| 服务来源 | Service Source | 网关关联后端服务的来源,支持 TSF、TKE、EKS、SCF、CVM、注册中心(Nacos/Consul/Polaris)、域名、IP 列表、PrivateDNS 等。 |
| 服务 | Service | 网关中代理的后端服务对象,对应一组后端节点。 |
| 路由 | Route | 定义请求如何匹配(Host、Path、Method、Header 等)并转发到目标服务的规则。 |
| 插件 | Plugin | 可插拔的网关功能扩展,用于认证鉴权、限流、改写、流量镜像等。 |
| 证书 | Certificate | 用于网关对外提供 HTTPS 服务的 SSL 证书。 |
| 域名 | Domain | 网关对外提供服务的域名,用于配置 HTTPS 协议入口。 |
| 弹性伸缩 | Auto Scaling | 网关根据预先设定的指标规则或定时规则自动增加或减少节点数量。 |
| 模型服务 | Model Service | 封装对一个特定大模型供应商的调用配置,包含服务地址、模型协议、模型密钥等。(AI 网关) |
| 模型 API | Model API | 网关对外暴露的模型调用端点,客户端通过访问该 API 来使用大模型能力。(AI 网关) |
| 模型密钥 | Model Key | 用于安全存储和管理访问第三方大模型服务所需的凭证。(AI 网关) |
| 消费者 | Consumer | 代表调用 API 的客户端身份,需配置 API Key 等认证凭证。(AI 网关) |
| 消费者组 | Consumer Group | 对消费者进行分组,并统一授权其访问模型 API 的权限。(AI 网关) |
输入参数与返回参数释义
Limit 和 Offset
用来控制分页的参数。Limit 为单次返回的最多条目数量,Offset 为偏移量。当相应结果是列表形式时,如果数量超过了 Limit 所限定的值,那么只返回 Limit 个值。
举例来说,参数 Offset=0&Limit=20 返回第 0 到 19 项,Offset=20&Limit=20 返回第 20 到 39 项,Offset=40&Limit=20 返回第 40 到 59 项;以此类推。
Ids.N
同时输入多个参数的格式。当遇到形如这样的格式时,那么该输入参数可以同时传多个。例如:
GET 请求或者 POST x-www-form-urlencoded 请求:Ids.0=gateway-xxxx&Ids.1=gateway-yyyy&Ids.2=gateway-zzzz
以此类推(以下标 0 开始)。
POST json 请求:{"Ids": ["gateway-xxxx", "gateway-yyyy", "gateway-zzzz"]}
API 快速入门
这里针对几个典型的使用场景对云原生智能网关 API 的使用方式进行说明:
云原生网关场景
- 通过使用 创建网关实例 API,提供节点规格、VPC、子网等必要信息,即可创建一个新的云原生网关实例。
- 通过使用 创建服务来源 API,选择目标网关实例和来源类型(如 TKE、Nacos、Polaris 等),即可将后端的注册中心或容器集群接入到网关。
- 通过使用 创建服务与路由 API,配置匹配条件(Host、Path、Method)和后端目标服务,即可实现请求的分发与代理。
- 如需管理网关插件,可以使用 创建插件 API 将鉴权、限流、改写等插件配置绑定到指定服务或路由。
- 如需管理 HTTPS 证书,可以使用 管理证书 API 上传或绑定 SSL 证书到网关域名。
AI 网关场景
- 通过使用 创建模型服务 API,选择模型供应商(混元、OpenAI、自定义等)并绑定模型密钥,即可接入后端大模型。
- 通过使用创建模型 API,配置请求协议(OpenAI)、Base Path,并绑定模型服务,即可对外暴露模型调用端点。
- 通过使用 创建消费者 API,创建调用方身份并生成 API Key 凭证,即可实现模型 API 的鉴权调用。
- 通过使用 管理消费者组 API,将消费者加入消费者组并授权模型 API 的访问权限。
使用限制
- API 创建的资源遵循云原生智能网关产品文档所描述的数量限制,和官网所创建的资源共用配额。
- 更具体的限制请参考对应 API 接口文档或产品文档。
- 默认接口请求频率限制请根据具体接口文档说明,超出频率限制时会返回错误码
RequestLimitExceeded。 - 云原生智能网关的部分功能需要依赖其他腾讯云产品(如 CVM、CLB、TKE、VPC 等),使用时需确保相关产品已开通且资源充足。