查看及管理运维监控API
为了保障应用能够正常调用API,同时能够保护系统,数据服务支持监控API的运行情况,包括查看异常影响分析、访问趋势分析、应用调用情况、查看API运行详情、API影响分析、配置API限流和API告警。本文为您介绍如何查看API调用情况及配置API限流和API告警。
查看运维总览
在Dataphin首页,单击顶部菜单栏服务。
按照下图指引,进入运维监控页面。
在运维监控页面的顶部区域,查看发布API数、在线API数、调用API数、在线API调用率、API调用次数、调用异常次数、错误率、offline百分比、调用异常API数 的总览数据。
总览数据
描述
发布API数
指定服务项目内所有发布到市场上的API总数。
在线API数
指定服务项目内所有已绑定APP可在线调用的API总数。
调用API数
在指定时间段内,指定服务项目内所有调用API的个数。
在线API调用率
在指定时间段内,指定服务项目内所有API的调用总次数/在线的API总数*100%。
API调用次数
在指定时间段内,指定服务项目内所有API的调用总次数。
调用异常次数
在指定时间段内,指定服务项目内所有API的调用错误总次数。
错误率
在指定时间段内,指定服务项目内所有API的调用错误总次数/调用总次数*100%。
offline百分比
在指定时间段内,指定服务项目内API调用错误返回offline错误总次数/调用总次数*100%。
调用异常API数
在指定时间段内,指定服务项目内API调用总时长/API调用总次数。
查看异常影响分析
基于已选择的时间段和服务项目,为您展示服务项目下所有API的调用异常次数API Top10。同时您可以将鼠标悬停至某API的异常图上可以查看异常的次数。
查看访问趋势分析
访问趋势分析包括调用异常趋势及调用异常影响趋势。调用异常趋势为您展示应用调用API的次数及调用API异常的次数;调用异常影响趋势为您展示API调用异常影响次数及API调用影响的应用数,帮助您发现及处理调用异常的API和APP。
查看应用调用情况
在应用运行情况区域以应用为维度为您展示应用名称、应用分组、所属服务项目、负责人、绑定API数、调用次数、调用异常次数、平均响应时长、错误率、offline百分比、最近调用时间。

您可以点击操作列下的调用分析,查看对应应用的每个API的调用分布情况,也可点击右上角的导出Excel按钮,导出应用的调用分析。

查看API运行情况
在API运行情况区域以API为维度为您展示API的API_ID、API名称、所属服务项目、授权应用数、调用次数、调用异常次数、平均响应时长、错误率、offline百分比、创建人、最近调用时间。同时您也可以对API进行配置API限流和配置API告警。

配置API限流
仅超级管理员及API的开发者支持配置API限流。
在API运行情况区域,单击限流。
在API限流配置对话框,配置参数。
参数
描述
限流状态
选择限流状态。
单位时间
选择限流的单位,系统提供的单位时间包括:
sec
min
hour
day
API流量限制
填写API限流的数据。例如,企业所购买的总流量为每秒查询率是500,如果单位时间选择sec,则API流量限制填写的数据应该小于等于500。
App流量限制
填写API的下游App的流量控制。填写APP流量限制的规则:
APP流量限制对API下的所有App生效。
APP流量限制必须小于等于API流量限制。
API流量限制的优先级大于APP流量限制。例如,API流量限制为每秒查询率是1000,App1的流量限制为每秒查询率是500,App2的流量限制为每秒查询率是500,App3的流量限制为每秒查询率是500,各App流量限制的总和大于API的流量限制,但流量限制的上线为API流量限制。
APP流量限制大于API流量限制时,系统会给出报错信息。
添加App
单击添加APP,根据API限流配置页面提示选择应用、配置限流次数。
填写限流次数的规则:
特殊App的限流次数必须小于等于API流量限制。
特殊App的限流次数大于API流量限制时,系统会给出报错信息。
单击确定,完成API限流的配置。
如果一个时间窗口内的请求达到限制速率,则系统通过排队、等待或降级等方式,来保护系统。
配置API告警
在API运行情况区域,单击告警。
在API告警页面,配置参数。
参数
描述
监控指标
选择告警规则的API监控指标。监控指标包括:
调用次数:单位时间内,调用API的总次数。
平均响应时长:单位时间内,API调用总时长/API调用总次数。
错误率:单位时间内,API调用错误总次数/API调用总次数。
单位时间
选择API调用的单位时间。单位时间包括1min 、5min、10min、30min、60min。
操作符
选择监控指标与触发阈值的比较的操作符。操作符包括<=, <,>,>=,=, !=。
触发阈值
填写告警规则的触发阈值。
通知方式
选择告警信息通知给通知人的方式。通知方式包括:
邮件
电话
短信
钉钉
通知人
选择告警信息的接收人。
静默期
在短时间内多次告警,可以设置一个静默期,在发送告警信息后的静默期期间,系统不再重复发送相同API告警规则的信息。
单击确定,完成API的告警配置。
应用调用API运行过程中,如果触发了监控告警规则,系统会给您发送告警消息,便于您及时发现并处理异常。