更新时间:2024-09-27 GMT+08:00
分享

数据服务简介

DataArts Studio数据服务旨在为企业搭建统一的数据服务总线,帮助企业统一管理对内对外的API服务。数据服务为您提供快速将数据表生成数据API的能力,涵盖API发布、管理、运维的全生命周期管理,帮助您简单、快速、低成本、低风险地实现微服务聚合、前后端分离、系统集成,向合作伙伴、开发者开放功能和数据。

相对于数据共享交换或其他数据开放形式,使用数据服务进行数据开放具备如下优势:
  • 统一接口标准,减少上层应用对接工作量。
  • 将数据逻辑沉淀至数据平台,实现应用逻辑与数据逻辑解耦,在减少数据模型的重复开发的同时,避免数据逻辑调整带来的“散弹式修改”。
  • 将数据逻辑相关的存储与计算资源下沉到数据平台,降低应用侧的资源消耗。
  • 减少大量明细、敏感数据在应用侧的暴露,同时通过API审核发布、鉴权流控、动态脱敏等手段,提升数据安全能力。

值得注意的是,数据服务是通过将数据逻辑封装成统一标准的Restful 风格API从而实现数据开放,适用于小批量数据的快速响应交互场景。如果为大量数据开放的场景,更适于通过数据共享交换或其他方案实现,这种情况下,建议您通过数据安全进行权限管控、敏感数据识别、数据脱敏、数据水印等手段保护数据安全。

API开放方使用流程

您作为API提供者,需要实现一个或一组API的开放,那么您需要先后完成以下工作:
  1. 购买并管理专享版集群

    如果您需要使用数据服务专享版,需要先购买专享版集群。

  2. 新建数据服务审核人

    在创建API前,需要新建数据服务审核人。

  3. 创建API

    创建API即生成API注册API。其中,生成API支持两种方式(配置方式生成API脚本/MyBatis方式生成API)。

  4. 调试API

    API创建后需要验证服务是否正常,管理控制台提供了调试功能。

  5. 发布API

    只有将API发布后,API才支持被调用。

  6. 管理API

    您可以根据您的需要,对已创建发布的API进行管理。

  7. 编排API

    编排API是将已经开发好的服务API接口,在无需编写复杂代码的情况下,根据特定的业务逻辑和流程进行可视化的重组和重构,从而实现在不影响原生接口的前提下进行简便的二次开发。

  8. (可选)配置流控策略

    为了保护后端服务的稳定的考虑,您可以对API进行流量控制。

  9. (可选)主动授权API

    应用定义了一个API调用者的身份。对于使用APP或IAM认证方式的API,必须在API授权后,才能获得认证信息以用于API调用。

API调用方使用流程

您作为API调用者,需要实现一个API的调用,那么您需要完成以下工作:
  1. 获取API

    从服务目录获取需要调用API。仅在API发布后,才支持被调用。

  2. 申请API授权

    对于API调用者而言,如果API开发者未授权APP或IAM认证方式的API,则需要自行申请API授权,等待审批通过后才能进行API调用。

  3. 调用API

    API调用者完成以上步骤后,可以进行API调用。

总览页面说明

在总览页用户可以看到丰富的监控数据视图。数据服务总览页面分别从API开放方和API调用方的视角,统计了API的相关度量数据。

图1 API总览
表1 API开放方数据统计

界面

说明

发布趋势

从每天、每周、每月、每年的维度统计了API开放方发布的API数量。

调用趋势

从半天、每天、每周、每月的维度统计了API开放方发布的API,被调用的次数。

调用比率TOP5

统计API开放方所开放的API,被调用的比率,包含成功率、失败率、合法率和非法率。

调用时间TOP5

统计API开放方所开放的API,被调用时长,支持统计的维度包含时长平均总值、成功时长平均总值,失败时长平均总值。

调用次数TOP5

统计API开放方所开放的API,被调用次数排名TOP5的,支持统计的维度包含调用总次数、成功次数、失败次数、合法次数和非法次数。

已发布

统计API开放方已成功发布的API数量。

开发中

统计API开放方开发中的API数量。

申请者

统计API开放方已成功发布的API,被申请调用的应用数量。

调用成功

统计API开放方已成功发布的API,被应用成功调用的次数。

调用失败

统计API开放方已成功发布的API,被应用调用失败的次数。

总调用次数

统计API开放方已成功发布的API,被应用调用的总次数。

图2 调用总览
表2 API调用方数据统计

界面

说明

调用趋势

从每天、每周、每月、每年的维度统计了API调用方调用的API数量。

调用比率

统计调用方最近7天内调用API的成功和失败比例。

已申请

统计API调用方,在数据服务平台申请调用的API数量。

调用成功

统计API调用方在数据服务平台成功调用API的次数。

总调用次数

统计API调用方在数据服务平台调用API的总次数。

相关文档