HTTP API基于HTTP协议的接口,可以快速对外暴露分布式系统的内部服务,本文将指导您如何通过控制台创建HTTP API。
适用场景
云原生API网关提供了实例内和实例外两种创建API的方式,分别适用以下场景:
实例内创建API
资源的专用管理:API仅需在特定实例内使用,管理特定资源或内部逻辑。
安全性和隔离性:数据或功能需要严格隔离以确保安全性,仅在实例内调用。
简化服务配置:简化在特定实例中的API配置和管理。
实例外创建API
跨实例共享访问:多个实例共享 API 定义信息。
集中管理和监控:统一权限控制、日志记录和流量管理。
实例内创建的API仅在对应实例中可见并管理。
实例外创建的API不支持在实例内进行编辑和删除,需要前往实例外API列表中操作。
通过控制台创建HTTP API
云原生API网关提供了实例内和实例外两种创建API的方式:
实例外API
登录云原生API网关控制台。左侧导航栏选择API,并在顶部菜单栏选择地域。
单击创建API,然后单击HTTP API卡片中的创建。
实例内API
登录云原生API网关控制台。左侧导航栏选择实例,并在顶部菜单栏选择地域。
在实例页面,单击目标网关实例ID。左侧导航栏选择API,单击右上角创建API。
单击HTTP API卡片中的创建。
在创建HTTP API面板中配置相关参数,单击确定。
配置项
说明
API名称
自定义创建的API名称,API名称需要全局唯一。
描述
填写API相关的描述。
资源组
选择目标资源组。您可单击右侧的创建资源组。
通过导入Ingress创建HTTP API
前提条件
您需要先在云原生API网关服务里创建容器服务的服务来源,详情可参见服务来源管理。
操作步骤
云原生API网关提供了实例内和实例外两种创建API的方式:
实例外API
登录云原生API网关控制台。左侧导航栏选择API,并在顶部菜单栏选择地域。
单击创建API,然后单击HTTP API卡片中的导入Ingress。
实例内API
登录云原生API网关控制台。左侧导航栏选择实例,并在顶部菜单栏选择地域。
在实例页面,单击目标网关实例ID。左侧导航栏选择API,单击右上角创建API。
单击HTTP API卡片中的导入Ingress。
单击HTTP API中的导入Ingress。在导入Ingress页面填写Ingress相关配置,并单击确定。
配置项
描述
API名称
API名称,您还可以单击添加描述对路由进行说明。
描述
API描述,最多支持255个字符。
所属实例
选取对应的云原生API网关实例。
来源集群
服务来源为Ingress所在的容器服务集群。
资源组
选取对应的资源组。
命名空间
需要监听的命名空间,如果留空,则表示监听所有命名空间下的Ingress资源。
IngressClass
需要监听的IngressClass,如果留空,则表示监听所有类型的Ingress资源。
更新Ingress Status
开启后,被监听的Ingress中的Status Endpoint将会被替换成网关入口的访问地址。