# 平台服务
 
## 数据服务

数据服务中，可以将平台中的资源发布成REST API，提供给上层应用使用。

![image-20220124042546693](../images_v2.0/dataapi/dataapi-manage.png)
 
## 创建API

本系统目前共支持四种API来源，包括标准指标、标准标签、标准分群及实体画像。

<a id="indicator-service"></a> 

### 指标服务

指标服务分为实时服务和基础服务两种。实时服务是指按照指标的计算规则，实时计算指标表并返回。基础服务是指返回指标上次运行后的结果表。

#### 实时服务

选择一个启用状态的标准指标，创建该指标的实时服务。每个指标只能有一个实时服务。

#### 基础服务

首先要选择一个启用状态的标准指标，根据业务需求配置请求参数、返回参数、排序等。

- 请求参数：可以配置指标中的一个字段作为API的请求参数，并且配置参数规则（规则包括=、>、<、>=和<=）
- 返回参数：可添加或删除字段作为API的返回值
- 排序字段：API返回值将安装配置的排序规则进行排序

![image-20220124042808426](../images_v2.0/dataapi/dataapi-indicator.png)


#### 标签服务

选择一个启用状态的标准标签，标签服务的配置同<a href="#indicator-service">指标服务</a>大体类似，但标签服务有一个默认请求参数，即标签名称，且该参数不可修改。标签服务的返回参数为实体属性。

![image-20220124043008033](../images_v2.0/dataapi/dataapi-tag.png)
 
#### 分群服务

选择一个启用状态的标准标签，分群服务的配置同<a href="#indicator-service">指标服务</a>大体类似，但是分群服务请求参数为空、且不可配。
 
#### 实体画像服务

实体画像API为单实体画像服务，请求参数默认为实体编号，且不可修改。返回值为对象请求参数实体所在的标签及分群。

### 数据服务详情

创建好以后，可以在数据服务详情页查看API的详细信息。

![image-20230927043301080](../images_v4.0/dataapi/dataapi-details.png)

对于不同的服务类型，详情页的内容也有些许不同。
- 指标实时服务：详情页中包含服务的基本信息、可选参数、服务字段、结果示例、调用记录、关联关系(sql指标不展示)。
- 指标基础服务：详情页中包含服务的基本信息、输入条件、排序字段、服务字段、结果示例、调用记录、关联关系(sql指标不展示)。
- 标签服务：详情页中包含服务的基本信息、结果字段、结果示例、调用记录。
- 分群服务：详情页中包含服务的基本信息、结果字段、结果示例、调用记录。
- 实体画像：详情页中包含服务的基本信息、结果示例、调用记录。

### 测试API

创建好以后，可以通过API测试页面来调试。

![image-20220124043640287](../images_v4.0/dataapi/dataapi-test.png)

对于不同的服务类型，测试页的内容也有些许不同。
- 指标实时服务：测试页中包含服务的请求地址、分页信息、输入条件(SQL指标为占位符)、排序字段、请求参数、可选返回字段、返回结果。
- 指标基础服务：测试页中包含服务的请求地址、分页信息、输入条件、排序字段、请求参数、返回字段、返回结果。
- 标签服务：测试页中包含服务的请求地址、分页信息、标签取值、请求参数、返回字段、返回结果。
- 分群服务：测试页中包含服务的请求地址、分页信息、请求参数、返回字段、返回结果。
- 实体画像：测试页中包含服务的请求地址、分页信息、实体编号、请求参数、返回字段、返回结果。

tips: 可选返回字段的取值范围为指标表中的各指标字段，除汇总指标外皆为单条。
 
### 服务启/停用

数据服务上线时才可访问，可根据具体需求进行配置上下线状态。

![image-20220124043924296](../images_v2.0/dataapi/dataapi-online.png)
 
### 服务权限

使用权限管理功能对数据服务的授权管理。

![image-20220124043950857](../images_v2.0/dataapi/dataapi-access.png)
 
## 数据预警
数据预警可以定期检查指标、标签、分群的数据，根据事先定义好的预警条件来判断异常值，并发送邮件或短信。

<a id="indicator-warning"></a>
### 指标预警

在标准指标列表下，点击指标上的预警图标可以弹出配置页面。

![image-20220124044652623](../images_v2.0/warning/warning-create-indicator.png)

配置以下参数即可。注意：接收通知人员的邮箱及手机号在偶数数据云平台用户管理中配置。

- 预警名称：设置预警名称。
- 预警级别：对预警划分级别，预警级别包括提示、次要、重要、紧急。
- 预警条件：预警条件包含最小阈值和最大阈值，最小阈值即当预警数据小于最小阈值时发生预警，最大阈值即当预警数据大于最大阈值时发生预警，二者至少配置一项
- 描述信息：预警信息的具体描述
- 通知开关：开启通知开关后，发生预警时会根据选择的通信方式（邮件或短信）通知配置的接收人员。(在使用预警通知功能时，需要管理员为相应的子用户订阅`Kepler预警消息`， 位置在`用户管理`-`订阅消息`中)
- 监控开关：配置周期性定时监控预警，周期单位包括秒、分、时、天、周、月、季、年
- 运行预警：开启运行预警后，每次运行预警实例的同时会对运行结果数据进行监控预警

![image-20220721163657091](../images_v2.0/warning/warning-config-indicator.png)
 
### 标签预警

标签预警同<a href="#indicator-warning">指标预警</a>类似，仅仅比指标预警多了一项“预警目标”，需要选择一个待预警标签，并选择预警类型，预警类型包括标签新增实体数、减少实体数、当前实体总数以及当前标签所占实体总数的百分比四项。

![image-20220124050007307](../images_v2.0/warning/warning-tag.png)
 
### 分群预警

分群预警同<a href="#indicator-warning">指标预警</a>类似，仅仅比指标预警多了一项“预警目标”，需要选择预警类型，预警类型包括分群新增实体数、减少实体数、当前实体总数以及当前标签所占实体总数的百分比四项。

![image-20220124094259085](../images_v2.0/warning/warning-segment.png)
 
### 预警服务管理

在指标上配置好的预警服务会可以在指标预警模块进行查看与管理。

![image-20220124045505495](../images_v2.0/warning/warning-manage.png)
 
### 预警历史
点击“预警历史”标签，可以查看系统中全部的预警历史。

![image-20220124045727794](../images_v2.0/warning/warning-history.png)