欢迎使用注册配置治理 API(以下简称注册配置治理 API)。
腾讯云注册配置治理提供弹性、高效、稳定的注册配置中心、服务治理、云原生网关能力。基于北极星(Polaris)、ZooKeeper、Nacos 等开源组件,提供微服务注册发现、配置管理、服务治理、云原生 API 网关等全栈微服务解决方案,帮助用户快速构建和管理微服务架构。
注册配置治理向用户提供以下核心能力:
- 云原生网关:提供高性能、高可用的 API 网关服务,支持服务路由、负载均衡、限流熔断、认证鉴权等功能。
- 注册配置中心(北极星 Polaris):提供服务注册发现、健康检查和元数据管理功能。
- 配置中心(北极星 Polaris):提供集中化的配置管理能力,支持配置动态下发和版本管理。
- 微服务引擎:提供 Nacos、ZooKeeper、Consul 等主流微服务引擎的托管服务。
用户可以使用本文档介绍的 API,并参照相应的示例,对注册配置治理进行相关操作:如创建网关实例、管理服务配置、配置服务路由等;支持的全部操作可参见 API 概览。
请确保在使用这些接口前,已充分了解了 注册配置治理产品概述。
注意:
- 本章节注册配置治理 API 接口均为最新 API 3.0 接口,后续相关新增功能都会在此章节更新。我们强烈推荐您使用最新 API 3.0 接口。
- 现有旧版 API 接口功能依然保持,未来可能停止维护,如您仍需使用旧版接口可参考相关文档。
术语表
本文档涉及的一些常用术语如下:
| 术语 | 英文 | 说明 |
|---|---|---|
| 云原生网关 | Cloud Native API Gateway | 基于 Kong 的高性能 API 网关,提供路由、负载均衡、认证鉴权、限流熔断等能力。 |
| 网关实例 | Gateway Instance | 云原生网关的运行实例,包含节点、网络和配置信息。 |
| 服务 | Service | 网关中定义的后端服务,包含服务来源和 Upstream 配置。 |
| 路由 | Route | 定义请求转发规则,将特定路径的请求转发到目标服务。 |
| 命名空间 | Namespace | 北极星中用于隔离和管理服务的逻辑单元。 |
| 服务(北极星) | Service (Polaris) | 北极星中注册的服务实例,包含服务名、实例列表和元数据。 |
| 服务实例 | Service Instance | 服务的具体运行实例,包含 IP、端口和健康状况。 |
| 配置文件 | Configuration File | 配置中心管理的配置文件,支持版本管理和动态下发。 |
| 配置组 | Configuration Group | 配置文件的分类管理单元,用于组织和管理相关配置文件。 |
| 泳道 | Lane | 全链路灰度发布中的流量隔离单元,确保灰度流量在灰度环境中流转。 |
| 微服务引擎 | Microservice Engine | 托管的 Nacos、ZooKeeper、Consul 等微服务基础设施。 |
输入参数与返回参数释义
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
以此类推(以下标 0 开始)。
POST json 请求:{"Ids": ["gateway-xxxx", "gateway-yyyy"]}
API 快速入门
这里针对几个典型的使用场景对注册配置治理 API 的使用方式进行说明:
云原生网关场景
- 通过使用 创建云原生 API 网关实例 API,提供网关名称、节点规格等必要信息,即可创建一个云原生网关实例。
- 通过使用 创建云原生网关服务 API,配置后端服务来源,即可定义网关的后端服务。
- 通过使用 创建云原生网关路由 API,配置路由规则,即可将请求转发到目标服务。
- 如需配置访问控制,可以使用 创建或编辑云原生网关访问控制 API 配置 IP 白名单或黑名单。
- 如需配置限流规则,可以使用 创建云原生网关限流插件(服务) API 对服务进行流量控制。
北极星服务治理场景
- 通过使用 创建命名空间 API,提供命名空间名称,即可创建一个服务隔离单元。
- 通过使用 创建服务 API,提供服务名称和相关配置,即可在指定命名空间下创建一个服务。
- 通过使用 创建服务实例 API,提供服务实例的 IP 和端口,即可将服务实例注册到指定服务。
- 如需管理配置,可以使用 创建配置文件组 API 创建配置分组,然后使用 创建配置文件 API 创建具体的配置文件。
微服务引擎场景
- 通过使用 创建引擎实例 API,选择引擎类型(Nacos、ZooKeeper 等)和规格,即可创建一个托管的微服务引擎实例。
- 通过使用 查询引擎实例访问地址 API,获取引擎的连接地址,即可在应用中配置连接信息。
- 如需开启公网访问,可以使用 修改引擎公网访问配置 API 开启公网访问能力。
使用限制
- API 创建的资源遵循注册配置治理产品文档所描述的数量限制,和官网所创建的资源共用配额。
- 云原生网关默认接口请求频率限制为 20 次/秒(查询路由列表接口为 300 次/秒),频率限制维度为 API + 接入地域 + 子账号。
- 北极星相关接口默认请求频率限制为 20 次/秒,超出频率限制时会返回错误码
RequestLimitExceeded。 - 微服务引擎实例创建后,引擎类型不可变更,请在创建前确认所需引擎类型。
- 更具体的限制请参考对应 API 接口文档或产品文档。