1. 概述
1.1 版本
| FineDataLink 版本 | 功能变动 |
|---|---|
| 4.2.17.5 | 新增「调用详情存储」功能 |
1.2 应用场景
IT 发布一个数据服务接口给业务人员调用,业务人员反馈“接口报错”或“数据不对”时,需要快速定位问题根源,并界定是 API 本身的问题,还是调用方传参错误。
目前 IT 人员无法看到调用者实际传入的 Request Body 和系统返回的 Response Body,导致双方对请求体和响应数据的正确性各执一词,却无法还原调用事实。
1.3 功能简介
1)支持为单个数据服务 API 配置调用详情,API 被调用后,可查看调用 API 时的请求内容、返回内容、SQL详情。

2)支持超管配置调用详情存储策略。

2. 对单个数据服务 API 配置调用详情
2.1 场景模拟
IT 发布一个数据服务接口给业务人员调用,业务人员反馈“接口报错”或“数据不对”时,需要快速定位问题根源,并界定是 API 本身的问题,还是调用方传参错误。
2.2 设置调用详情存储
注:需要有该 API 的管理权限;适用于数据查询 API 和数据接收 API,本节以数据查询 API 为例。
1)IT 人员进入 API 的详情页,点击右上角「调用详情存储」按钮,进行配置。如下图所示:

| 设置项 | 说明 |
|---|---|
| 调用详情存储 | 该按钮默认关闭,若需要查看调用详情,需开启 |
| 存储范围 | 仅异常调用: 仅记录失败详情 所有调用: 记录所有调用详情,但会占用大量存储空间,建议仅在接口调试期间使用 |
| 详情内容 | 控制调用详情显示内容,建议勾选全部能勾选的按钮
|
2.3 再次调用 API
业务人员可再次调用 API。
2.4 查看调用详情
IT 人员,点击「运维中心>服务监控>对应API的调用详情」,查看调用时的请求内容、返回内容、SQL详情,排查问题原因。

当 API 调用失败且未配置「调用详情」时,仅显示「报错详情」Tab。
当 API 调用成功且未配置「调用详情」时,「调用详情」列显示为 – ;配置「调用详情」后,展示三个Tab:请求内容、返回内容、SQL详情。
数据接收 API 不显示「SQL详情」Tab。
2.5 后续步骤
问题排查后建议将 API 调用详情存储范围更改为「仅异常调用」,否则将占用大量存储空间。

3. 设置调用详情存储策略
3.1 设置存储策略
超管登录 FDL 工程,点击「数据服务>服务设置按钮>调用详情存储」,可设置调用详情的存储位置、保留时间、存储上限。如下图所示:
注:适用于数据查询 API 和数据接收 API。

| 设置项 | 说明 |
|---|---|
| 数据源类型 | 目前只支持存储在 服务器本地目录 中 |
| 文件夹地址 | 不可修改,默认为dpworks/ds_call_detail_files,完整地址为:%FDL%/webroot/WEB-INF/dpworks/ds_call_detail_files |
| 调用详情保留时间 |
|
| 调用详情存储上限 |
|
| 单项详情存储上限 |
|
3.2 调用详情存储形式说明
API 得调用详情存储在%FDL%/webroot/WEB-INF/dpworks/ds_call_detail_files文件夹下,以 JSON 文件的形式进行存储,根据uuid 命名。

