跳到主要内容

API运行管理

目录​

一、概述​

　API运行管理是系统中用于控制和管理已部署API的运行状态的功能模块。它允许查看API的运行情况，包括测试状态、工作状态、后端服务状态等关键信息，并提供测试、启动、停止等操作功能。通过API运行管理，管理员可以确保系统中的API服务正常运行，及时发现并解决问题，保障业务系统的稳定性和可用性。API运行管理是API全生命周期管理的重要组成部分，负责API注册到网关之后的管理。

二、功能操作指南​

（一）操作入口​

操作步骤：登陆产品首页，运维中心—运行管理—API运行管理页面。

1

（二）API概览​

API页面主要展示API状态的监控，可以看到API的状态监控情况，API名称、API类型、版本、测试状态、工作状态、后端服务无状态等信息；实时显示API的工作状态（启用、停用、禁用）；监控后端服务的状态（启用、停用、禁用），以及测试状态（测试通过、测试失败、测试中、未测试）。

API注册审批通过，第一次启动之前为草稿状态。

工作状态主要包括：启用、停用

  • 启用：显示为绿色标签，标记为"启用"，API处于正常运行状态，可以接收和处理请求，系统会持续监控启用状态的API的健康状况，客户端可以正常访问和使用该API。

对应的操作按钮为"停止"，点击后可将API切换到停用状态

  • 停用：显示为黄色标签，标记为"停用"，API已部署但当前不接收新的请求，API的配置和资源仍然保留在系统中，客户端无法访问该API，会收到服务不可用的响应，对应的操作按钮为"启动"，可以重新启动API。

1

API测试、启动、停止、或卸载​

用户可以根据API工作状态对其执行不同操作，草稿状态的API启动后变为启用状态，启用状态的API停止后变为停用状态，停用状态的API启动后变为启用状态。

注意：停用状态的API无法进行测试。

  • 批量或单个启动或停止：在API列表顶部，点击"启动"按钮可启动所有符合条件的API；点击"停止"按钮可停止所有符合条件的API。

1

  • API卸载：只有处于停用状态的API并且状态为撤销待审核才能卸载，在其他状态下无法被卸载，防止用户执行不适合当前状态的操作；卸载后的API会转至已卸载页面。

1

  • API测试：选定具体API，操作API列表顶部的测试，测试API的可用性和响应，需要注意的是审批状态为API撤销待审批状态下的API无法进行测试。

1

API搜索与筛选​

在搜索区域，从下拉菜单中选择搜索字段（API名称、工作状态、API类型等）

  1. 在输入框中输入搜索关键词，输入框会根据选择的字段显示相应的提示文本

  2. 点击 "搜索" 按钮进行查询，系统将显示符合条件的API

  3. 点击 "重置" 按钮可清除所有搜索条件，恢复默认显示

搜索支持的字段包括：API名称、工作状态、API类型、代理方式、应用系统、系统负责人、业务部门、API注册人、API注册时间。

1

API资源组管理​

在系统中，资源组通常显示在左侧导航区域，用户可以通过点击资源组来筛选和查看该组内的API。资源组的合理规划和使用可以显著提高API管理的效率，特别是在API数量较多的企业环境中。

  1. 使用价值：
    • 提高API的可发现性，便于快速定位特定API
    • 实现API的逻辑分组，便于批量管理
    • 支持基于权限的访问控制，可以为不同团队分配不同资源组的管理权限

1

API参数设置​

设置API参数的步骤如下：

  1. 在API列表中找到目标API
  2. 点击操作列中的 "设置" 按钮，打开API设置对话框

1

  1. 在对话框中，可以配置以下参数：
    • 熔断配置： API熔断配置是为防止服务崩溃的关键措施，核心是在依赖服务异常时快速熔断请求，避免资源耗尽。

1

  • 负载均衡配置： 提供集群策略（轮询、哈希）和健康检查（主动、被动）。

1

  • 功能开关配置： 提供重试、认证、客户端认证、CORS跨域访问、打开后端日志开关选项。

注意：只有后端服务 为自定义后端服务并且SSL安全通道启用时，客户端认证才可选

1

  • 流量控制规则： 提供无限制、流量控制、次数控制选项规则。

1

  • 访问控制规则： 提供IP控制、时间控制、ip控制拒绝选项规则和降级配置在系统压力过大、异常频发或服务不稳定时，主动牺牲部分非核心功能或降低服务质量。

1

  • HTTP/REST API数据处理规则：提供HTTP/REST API数据处理规则。

1 4. 完成设置后点击" 确定 "按钮保存配置

API调用地址​

点击操作列的URL，复制API 调用地址，用于外部系统集成。

1

API详情查看​

在API列表中，点击API名称（显示为蓝色链接文本）

系统将打开API详情，可查看（仅查看模式，不可编辑）正在使用的API详细配置信息或特定版本的API详细配置信息。如基本信息、后端配置、高级配置、请求参数定义、响应参数定义、管理配置、订阅信息和版本；

通过查看API详情信息，用户可以便于分析问题和优化设计。**

1

1

API配置​

在API列表中，点击具体API操作中的变更

系统将打开显示API的配置页面，在配置页面中可以配置（可编辑）基本信息、后端配置、高级配置、请求参数定义、响应参数定义、管理属性配置。

1

1

（三）已卸载API概览​

已卸载页面存放已被卸载的API，可以看到已被卸载API的名称、类型、版本、测试状态、工作状态等信息。

通过列表顶部的删除选项，可以对已被卸载API勾选进行单个或批量删除。

选定具体API右侧的另存选项，进入API另存设置，可对API名称、请求路径进行设置。

1

1