参数配置介绍

栏目:云苍穹知识作者:金蝶来源:金蝶云社区发布:2024-09-23浏览:1

参数配置介绍

变更记录


产品版本

更新内容更新日期
V5.0.011初始版本2022年6月
V6.0.4参数配置菜单路径调整,请管理员前往公共设置维护系统参数2023年12月




1 简介

1.1 功能介绍

OpenAPI系统参数允许用户设置日志记录级别、显示异常stack、查询接口的最大查询数量等选项,提升OpenAPI应用的灵活性


1.2 应用场景

通过可视化的参数配置,匹配用户在不同场景下的个性化需求

 

1.3 系统路径

【基础服务云→【公共设置【参数配置【系统参数】


1.4 字段说明

字段名称

详细解释

显示异常Stack

当API服务调用失败时,是否在返回结果中展示stack堆栈信息

大文本日志保存天数大文本日志保存的时间,默认为5天,取值范围是[1,25]
选择API调用日志级别设置日志记录级别,根据实际需要选择合适的级别记录API日志

是否统计API调用次数

控制是否统计API调用次数

查询参数-最大查询数量

控制查询操作接口的返回数量。当查询数据过大时,建议分页查询

打开限流控制

限流控制开关(待下架)

自定义servlet功能开启参数后,可以在API开发中新建自定义Servlet接口
扩展参数通过特定的扩展参数启用OpenAPI的灰度功能
插件应用插件所在应用
接口鉴权插件接口鉴权插件
API测试弹窗样式分屏/模态

 

1.5 按钮说明

按钮名称

详细解释

保存

保存当前系统参数信息。

刷新

刷新当前页面。

退出

点击退出按钮,退出当前页面。

 

2 主要操作

本节主要介绍每个参数的详细操作和功能。



2.1 显示异常Stack

API服务调用报错时,可以使用参数控制是否显示异常堆栈信息。




2.2 API调用日志

API默认记录摘要日志,可以通过参数配置,选择其他的日志级别,如不记录日志、记录摘要日志、记录详细日志、记录详细日志(大文本)当选择不记录时,系统不会记录API的调用日志,请谨慎设置。


  • 当记录摘要日志时,日志不会记录API的请求参数和返回参数。



  • 当记录详细日志时,日志会记录API的请求参数和返回参数,但最多只会存2000字符



  • 当记录大文本日志时,日志会记录全量的API请求参数和返回参数。


2.3 是否统计API调用次数

该参数可控制是否统计API得调用次数,默认打开,当开关关闭时,系统不会继续记录API 统计信息,也不再更新OpenAPI内的统计看板。



2.4 查询参数-最大查询数量

通过该参数来控制查询操作的最大返回数据,接口单次返回数据量不超过参数值,当量过大时建议分页查询。当最大查询数量参数设为X时,即使有数万条数据,最终接口也只返回符合条件的X条数据。




3 更多资讯

关于OpenAPI的更多资讯,请随时关注新特性公告



参数配置介绍

变更记录产品版本更新内容更新日期V5.0.011初始版本2022年6月V6.0.4参数配置菜单路径调整,请管理员前往公共设置维护系统参数2023年12月1 ...
点击下载文档
确认删除?
回到顶部
客服QQ
  • 客服QQ点击这里给我发消息