API管理
用户可进入顶部的「API管理」菜单,点击左侧的「API管理-API」查看当前所有的API,包括生成API、注册API、服务编排。
在API中,主要可进行API的状态管理,以及查看API。
-
API提交与发布:用户可对API进行提交、发布、撤回、禁用、二次发布、编辑、删除等七种操作,管理API状态。
-
查看API:用户可点击API名称查看API详情、API调用、API订购信息,掌握API使用信息。
API提交与发布

一般来说,配置完成的API至投入正常使用会经历以下状态/步骤:
-
未提交,未发布:API生成或注册后的初始状态,支持“编辑、提交”操作。
-
提交:将API提交至API网关,提交成功后的API可支持用户调用测试地址对API进行测试。
-
发布:一般在测试成功后使用,API发布成功后将在API市场可见,API申请者可进行申请,申请步骤详见API申请。
-
撤回:“已提交”的API支持撤回,撤回后不可使用第三方工具对API测试,可以对API进行编辑修改。
-
禁用:“已发布”的API支持禁用,禁用后该API在API市场不可见,不对外提供服务。禁用后的API支持“发布”操作,发布后该API可正常使用禁用前的版本。
-
二次发布:“已提交、已发布”的API支持二次发布,二次发布表示用“已提交”的新版本覆盖目前正常使用的“已发布”版本。
服务编排状态对API可执行操作的影响
为保证服务编排的正常使用,服务编排为“已提交”时,其下API节点不可撤回。服务编排为“已发布”时,其下API节点不可禁用。
如需修改API节点内容,需首先单独撤回服务编排,节点在多个服务编排中引用则需撤回所有的服务编排。
如需禁用API节点,需首先禁用服务编排,节点在多个服务编排中引用则需禁用所有的服务编排。
若需删除API节点,需首先单独删除服务编排,节点在多个服务编排中使用则需删除所有的服务编排。
查看API
点击API名称,可查看对应API。
API详情

-
基本信息:包括支持格式,请求协议,请求方式,超时时间,API ID等,特别地,“已提交”的API存在调用测试URL,用于在第三方工具中进行内部测试,测试无误后可发布至正式环境使用。
-
配置信息:数据源类型,数据源名称,数据表名称。
-
参数配置:输入参数与返回参数。
-
请求示例:不同调用方式下提供的request url,headers,body。
-
返回结果:调用该API返回的json样例。
安全与限制
-
支持修改安全组:安全组用于限制访问API的黑白名单,保障API访问的安全性。每个安全组是一组IP地址,用于限制此API在这些IP范围内调用或禁止调用。
-
支持修改API的单用户每秒调用次数:单用户每秒对API的调用次数的上限默认是2000。

API调用情况
支持查看最近24h、最近7天、最近30天、历史累计的API调用次数及趋势图 ,TOP10调用用户排行榜,以及查看错误日志。

目前错误日志包含:参数错误、禁用、未认证、超时、超过限制及其他。
-
参数错误:表示API调用参数解析异常,传参错误或解析失败;
-
禁用:表示该API已被禁用,不可调用;
-
未认证:表示API中的token不合法,未授权审批;
-
超时:表示请求超时;
-
超过限制:表示API未在申请周期内、或已超过申请次数;
-
其他:表示除上述错误外,发生的一些未知异常或不支持本次请求等;
API订购情况
支持查看该API所有订购用户的调用情况,以及停止某用户的API授权等。
