异常字典主要用于定义异常的名称、原因、解决方案、排查方式等信息,帮助运维人员快速定位故障点。
# 新增异常字典
登录运维人员账户(monitor/000000),进入运维门户,点击菜单“API运维”>“异常字典”,进入“异常字典”页面。
在“异常字典”页面,点击”新增”按钮,可新增异常字典相关信息。
字段名称 说明 异常码 异常标识,需唯一 异常名称 异常名称 异常匹配规则 响应报文异常匹配规则 异常信息 此异常的示例信息 异常原因 异常产生的原因 解决方案参考 给出此异常的解决方案 异常次数 统计此异常的次数 异常占比 统计此异常的占比(异常次数/调用总数)
2.1异常字典只对以下场景生效:
响应报错(状态码4xx或5xx)的调用。
正常响应(如:状态码200)但是业务异常校验判定为业务异常的调用。
2.2异常字典匹配规则:
2.2.1当异常响应报文包含异常匹配规则的内容时,则认为是匹配成功。
2.2.2当多个异常字典的异常匹配规则都匹配成功时,哪个异常字典的匹配成功次数多,则认为是哪种异常,当匹配成功次数一样时,默认取第一个异常。
2.2.3如果删除或编辑异常字典的异常匹配规则,之前统计的异常次数和异常占比不会清零,后续接口调用会根据新的异常匹配规则进行校验。
填写相关信息后,点击”确定”按钮,保存异常字典信息。
测试异常字典是否生效,可通过调用API接口的方式触发异常,并通过异常码进行搜索。
4.1 使用manager账号(默认密码:000000)登录系统,点击菜单“API市场”,选择”已订阅”页签,点击”测试”按钮,进入”测试”页面。如果没有订阅的接口, 请参考HTTP穿透(手动录入)文档进行API注册和订阅。
4.2 选择需要测试的API,点击”测试”按钮,进入”测试”页面。
4.3 确保参数正确,取消或重命名”Headers”中的OnlineToken参数,点击”测试”按钮,等待测试结果。
点击“异常名称” ,可查看异常字典详情和触发异常字典的异常API。
在异常API页签中,点击异常次数,可查看异常API的调用日志。
# 编辑异常字典
点击编辑,可对异常字典进行编辑。
# 删除异常字典
点击删除,可删除异常字典。
# 启停异常字典
点击启停,可对异常字典进行启停。停用异常字典后,异常字典将不会再被触发。
异常字典停用后,后续调用接口不会统计该异常。
# 调用日志根据异常字典查询异常日志
在“API运维->调用日志”查询调用日志时,可以根据异常字典查询异常日志。