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

数据服务简介

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

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

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

图1 数据服务架构图

操作视频

本视频为您介绍如何基于数据服务创建数据API,并通过调用数据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和APP的视角,统计了相关度量数据。

以专享版为例,监控视图各项指标含义介绍如下:

图2 API视角数据统计

表1 API视角数据统计

分类

指标

说明

数据总览区

已发布

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

开发中

统计开发中的API数量。

申请者

统计已发布API所授权的应用数量。

总调用

近7天(不含当天)所有集群下API的调用总次数。

成功

统计API调用成功的次数。

失败

统计API调用失败的次数。

合法

统计API合法调用的总次数,合法调用指校验通过的调用。

非法

统计API非法调用的总次数,非法调用指由于请求参数填写错误等原因导致的校验不通过的调用。

趋势图

调用趋势

展示所选时间维度下,集群维度的API调用次数曲线。

  • 时间维度:近12小时,近1天,近7天,近 30天
  • 集群维度:单集群,所有集群
  • 调用次数:调用总次数、成功次数/失败次数、合法次数/非法次数

发布趋势

展示所选时间维度下,API发布次数曲线。

  • 时间维度:今日、本周、本月、今年。

TOP5统计

调用比率TOP5

统计所选时间维度下,按照集群维度的API调用比率,排序出TOP5 API。

  • 时间维度:近12小时,近1天,近7天,近 30天
  • 集群维度:单集群,所有集群
  • 比率:成功率、失败率、合法率、非法率

调用时间TOP5

统计所选时间维度下,按照集群维度的API调用时长,排序出TOP5 API。

  • 时间维度:近12小时,近1天,近7天,近 30天
  • 集群维度:单集群,所有集群
  • 时长:时长平均总值、成功时长平均总值,失败时长平均总值

总调用次数TOP5

统计所选时间维度下,按照集群维度的API调用次数(同一API授权不同应用则合并计数),排序出TOP5 API。

  • 时间维度:近12小时,近1天,近7天,近 30天
  • 集群维度:单集群,所有集群
  • 调用次数:调用总次数、成功次数、失败次数、合法次数和非法次数。

单API调用次数TOP5

统计所选时间维度下,按照集群维度的API调用次数(同一API授权不同应用则分开计数),排序出TOP5 API。

  • 时间维度:近12小时,近1天,近7天,近 30天
  • 集群维度:单集群,所有集群
  • 调用次数:调用总次数、成功次数、失败次数、合法次数和非法次数。
图3 APP视角数据统计

表2 APP视角数据统计

分类

指标

说明

数据总览区

已申请

统计所有API授权的APP数量。

总调用

近7天(不含当天)所有集群下APP和IAM认证方式API的调用总次数。

成功

统计APP和IAM认证方式API调用成功的次数。

失败

统计APP和IAM认证方式API调用失败的次数。

合法

统计APP和IAM认证方式API合法调用的总次数,合法调用指校验通过的调用。

非法

统计APP和IAM认证方式API非法调用的总次数,非法调用指由于请求参数填写错误等原因导致的校验不通过的调用。

趋势图

调用趋势

展示所选时间维度下,所有集群的APP和IAM认证方式API调用次数曲线。

  • 时间维度:近12小时,近1天,近7天,近 30天
  • 调用次数:调用总次数、成功次数/失败次数、合法次数/非法次数

TOP5统计

调用比率TOP5

统计所选时间维度下,所有集群的APP和IAM认证方式API调用比率,排序出TOP5 API。

  • 时间维度:近12小时,近1天,近7天,近 30天
  • 比率:成功率、失败率、合法率、非法率

调用时间TOP5

统计所选时间维度下,所有集群的APP和IAM认证方式API调用时长,排序出TOP5 API。

  • 时间维度:近12小时,近1天,近7天,近 30天
  • 时长:时长平均总值、成功时长平均总值,失败时长平均总值

总调用次数TOP5

统计所选时间维度下,所有集群的APP和IAM认证方式API调用次数(同一API授权不同应用则合并计数),排序出TOP5 API。

  • 时间维度:近12小时,近1天,近7天,近 30天
  • 调用次数:调用总次数、成功次数、失败次数、合法次数和非法次数。

单APP调用次数TOP5

统计所选时间维度下,所有集群的APP和IAM认证方式API调用次数(同一API授权不同应用则分别计数),排序出TOP5 API。

  • 时间维度:近12小时,近1天,近7天,近 30天
  • 调用次数:调用总次数、成功次数、失败次数、合法次数和非法次数。

相关文档