searchusermenu
  • 发布文章
  • 消息中心
点赞
收藏
评论
分享
原创

数据服务功能说明

2024-05-29 09:16:12
3
0

数据服务旨在为企业提供全面的数据服务及共享能力,帮助企业统一管理面向内外部的API服务。可以将数据表快速生成数据API,以及将已有API快速注册至本平台进行统一管理与发布。数据服务整体流程如下。

数据服务主要分三个模块:

1. 服务开发:

提供服务开发环境和工具,支持用户开发、定制和部署数据服务,包括数据API、数据查询服务、数据导出服务等,以满足不同业务需求的数据访问和集成。 用户可先行创建API分组,随后生成API支持向导模式,脚本模式,注册模式。

1)向导模式

向导模式可以可视化方式完成API的配置和发布操作。

首先选择数据源,目前支持mysql,oracle,doris,选择对应的库表,选择表字段作为请求参数,响应参数,排序字段,对指定字段可以进行过滤规则配置,其中响应参数可以配置脱敏规则。

2)脚本模式

脚本模式用户自行编写SQL脚本,再进行配置和发布操作。

首先选择数据源,目前支持mysql,oracle,doris,选择对应的库表,然后编写脚本,针对脚本可以使用自动解析辅助生成请求参数,响应参数,针对响应参数可以配置脱敏规则。

3)注册模式

注册模式用户可以配置需要访问的外部API,用户填写要访问外部API的后台服务Host、后台服务Path、后台超时时间,然后填写请求参数、返回内容示例、错误码等信息。

API支持在不同的API分组之间移动API,复制API,快速生成API。

API开发完成后,可以对API测试,测试通过后可以发布上线。

API上线后需要修改可以先下线API,修改后重新测试发布上线,重新发布后会生成新的版本,可以查看API版本列表,比对不同的版本,也可以回滚API到指定版本。

2. 服务管理:

管理和维护数据服务的生命周期,包括服务注册、服务发布、服务订阅等,提供统一的服务管理界面和操作,方便用户对服务进行管理和控制。服务管理API管理,API测试,API调用,API调用是相关应用授权,流控策略,告警策略管理。

1)API管理

API管理可以按照条件查询API列表,针对具体API进行上下线,测试,查看API文档,策略管理。

2)API测试

API测试是针对发布上过的API进行在线沙箱测试。

3)API调用

API调用相关的配置,包括应用授权,流控策略,告警策略。

(1)应用授权

应用授权模块可以管理应用,新增应用的时候可以生成唯一的appKey,appSecret配置授权访问的已上线的API,IP白名单,有效期。

(2)流控策略

流控策略模块可以管理流控策略,配置流控规则,如访问限制次数,时间单位,以及绑定关联的已上线的API。

(3)告警策略

告警策略模块可以管理告警策略,配置告警触发方式,告警条件(告警指标包括调用失败次数,调用失败率,平均响应时间),统计频率,告警等级,已经告警联系人或者机器人。

3. 服务监控:

监控和管理数据服务的运行状态和性能,包括服务的可用性、响应时间、吞吐量等指标,及时发现和解决服务故障和性能问题,保障数据服务的稳定性和可靠性。

针对API调用情况的统计分析,包括API计量大屏,API计量详情,API访问日志。

1)API计量大屏

    可以根据API分组、时间范围等组合查询统计指标,包括已发布总数、开发中总数、总调用次数、调用失败次数等;

    可以根据API分组来查询昨日调用量排行Top10;

    可以根据API分组来查询昨日出错量排行Top10;

    可以根据API分组、时间范围等组合查询API调用趋势;

可以根据时间范围来查询高频访问应用Top10;

2)API计量详情

可以根据API名称、路径、分组、类型、标签、创建时间等组合查询已经上线的API;

   可以选择某个具体API,查看监控图表,包括API请求次数和API平均响应时间;

3)API访问日志

可以根据API名称、应用名称、appKey、请求接收时间、访问状态等组合查询API的调用记录;具体的调用记录属性主要包括API名称、应用名称、appKey、访问参数、请求接收时间、请求返回时间、访问状态、响应时间和日志等。

0条评论
0 / 1000
nmy
3文章数
0粉丝数
nmy
3 文章 | 0 粉丝
nmy
3文章数
0粉丝数
nmy
3 文章 | 0 粉丝
原创

数据服务功能说明

2024-05-29 09:16:12
3
0

数据服务旨在为企业提供全面的数据服务及共享能力,帮助企业统一管理面向内外部的API服务。可以将数据表快速生成数据API,以及将已有API快速注册至本平台进行统一管理与发布。数据服务整体流程如下。

数据服务主要分三个模块:

1. 服务开发:

提供服务开发环境和工具,支持用户开发、定制和部署数据服务,包括数据API、数据查询服务、数据导出服务等,以满足不同业务需求的数据访问和集成。 用户可先行创建API分组,随后生成API支持向导模式,脚本模式,注册模式。

1)向导模式

向导模式可以可视化方式完成API的配置和发布操作。

首先选择数据源,目前支持mysql,oracle,doris,选择对应的库表,选择表字段作为请求参数,响应参数,排序字段,对指定字段可以进行过滤规则配置,其中响应参数可以配置脱敏规则。

2)脚本模式

脚本模式用户自行编写SQL脚本,再进行配置和发布操作。

首先选择数据源,目前支持mysql,oracle,doris,选择对应的库表,然后编写脚本,针对脚本可以使用自动解析辅助生成请求参数,响应参数,针对响应参数可以配置脱敏规则。

3)注册模式

注册模式用户可以配置需要访问的外部API,用户填写要访问外部API的后台服务Host、后台服务Path、后台超时时间,然后填写请求参数、返回内容示例、错误码等信息。

API支持在不同的API分组之间移动API,复制API,快速生成API。

API开发完成后,可以对API测试,测试通过后可以发布上线。

API上线后需要修改可以先下线API,修改后重新测试发布上线,重新发布后会生成新的版本,可以查看API版本列表,比对不同的版本,也可以回滚API到指定版本。

2. 服务管理:

管理和维护数据服务的生命周期,包括服务注册、服务发布、服务订阅等,提供统一的服务管理界面和操作,方便用户对服务进行管理和控制。服务管理API管理,API测试,API调用,API调用是相关应用授权,流控策略,告警策略管理。

1)API管理

API管理可以按照条件查询API列表,针对具体API进行上下线,测试,查看API文档,策略管理。

2)API测试

API测试是针对发布上过的API进行在线沙箱测试。

3)API调用

API调用相关的配置,包括应用授权,流控策略,告警策略。

(1)应用授权

应用授权模块可以管理应用,新增应用的时候可以生成唯一的appKey,appSecret配置授权访问的已上线的API,IP白名单,有效期。

(2)流控策略

流控策略模块可以管理流控策略,配置流控规则,如访问限制次数,时间单位,以及绑定关联的已上线的API。

(3)告警策略

告警策略模块可以管理告警策略,配置告警触发方式,告警条件(告警指标包括调用失败次数,调用失败率,平均响应时间),统计频率,告警等级,已经告警联系人或者机器人。

3. 服务监控:

监控和管理数据服务的运行状态和性能,包括服务的可用性、响应时间、吞吐量等指标,及时发现和解决服务故障和性能问题,保障数据服务的稳定性和可靠性。

针对API调用情况的统计分析,包括API计量大屏,API计量详情,API访问日志。

1)API计量大屏

    可以根据API分组、时间范围等组合查询统计指标,包括已发布总数、开发中总数、总调用次数、调用失败次数等;

    可以根据API分组来查询昨日调用量排行Top10;

    可以根据API分组来查询昨日出错量排行Top10;

    可以根据API分组、时间范围等组合查询API调用趋势;

可以根据时间范围来查询高频访问应用Top10;

2)API计量详情

可以根据API名称、路径、分组、类型、标签、创建时间等组合查询已经上线的API;

   可以选择某个具体API,查看监控图表,包括API请求次数和API平均响应时间;

3)API访问日志

可以根据API名称、应用名称、appKey、请求接收时间、访问状态等组合查询API的调用记录;具体的调用记录属性主要包括API名称、应用名称、appKey、访问参数、请求接收时间、请求返回时间、访问状态、响应时间和日志等。

文章来自个人专栏
技术总结
3 文章 | 1 订阅
0条评论
0 / 1000
请输入你的评论
1
0