可用性
API需要配置并发请求及流量控制
本条规则是Should类型的扩展规则,可提升API的可用性。
- 并发请求控制:指API最大允许的客户端连接数量。
- 吞吐量(TPS)控制:指API单位时间内可并发处理的能力。
- 传输流量控制:指API单位时间内传输的数据量。
API发布过程中必须保证API注册信息的准确性
本条规则是MUST类型的基本规则,可保障API的高可用性。
API发布是API生命周期中重要的部分,因此在发布过程中需要保证API的正确性、可读性、可用性,并对服务质量进行约束。
必须对API进行统一注册和统一管理,API注册目标系统为API中心。在API发布过程中必须保证API注册信息的准确性,保证API符合国家法规以及安全规定的要求。
API调用成功率>=99.99%
本条规则是MUST类型的基本规则,可保障API的高可用性。
API调用成功定义:调用API时响应码为除5XX外其余响应码。API调用成功的次数/总的API调用次数*100%就是调用成功率,该数值应大于等于99.99%。
服务API实际可用性与承诺的服务可用性需要100%吻合。当发现无法达到承诺的服务可用性时,API提供方从架构上考虑,通过增加可用区,增加多活部署等手段提升服务API的整体可用性。
API的TP99响应时长<3s
本条规则是MUST类型的基本规则,可保障API的高可用性。
要求从API网关到后端服务的API调用,99%的调用响应时长<3s,TP99响应时长就是满足百分之九十九的网络请求所需要的最低耗时。
TP99响应时长达标率=TP99响应时间符合要求的API数量/总的API数量*100%,该数值应小于3s。
服务API实际响应时间应与承诺的服务响应时间比不应小于99%,即至少99%的API响应时间应达到承诺的服务响应时间。当发现无法达到承诺的服务响应时间时,API提供方应从架构上通过扩容、缓存等手段提升API响应时间。
禁止在API请求中携带超长报文体
本条规则是MUST类型的基本规则,可保障API的高可用性。
API通道默认请求报文体长度(Body Size)限制为2MB,默认请求Header长度(Header Size)限制为1MB。
明确API吞吐量与并发量
本条规则是Should类型的扩展规则,可提升API的可用性。
在API的设计阶段需要对单位时间可处理的能力进行设计,指标包括吞吐量和并发量。
- 吞吐量(TPS)是指服务在单位时间内处理请求的数量,使用单位时间为秒。
- 并发量是指服务可以同时承载的正常使用系统功能的用户的数量。
服务API的最大吞吐量/并发量与承诺的服务吞吐量/并发量需要100%吻合。当发现无法达到承诺的吞吐量/并发量时,API提供方应从架构上通过扩容等手段提升吞吐量和并发量。