注册数据源¶
注册数据源是在通用数据服务上注册和管理数据的第一步,只有注册过的数据源才能通过通用数据服务为数据消费者提供各种类型的数据。
前提条件¶
开始之前,确保以下事项:
当前帐号已被分配所需的资产权限、操作权限点和包含 数据源 在内的菜单组。如未分配,联系应用管理员。
需要注册的所有 API 接口已按照通用数据服务规范进行标准化。更多信息,参见 通用数据服务接口规范。
操作步骤¶
在左侧导航栏中选择 数据源。
根据目标数据源的生效范围选择 公有数据源 或 私有数据源 标签页,点击 新建。有关公有/私有数据源的区别,参见 公有/私有数据源。
在 新建数据源 页面,参考以下信息输入数据源的基本信息。
字段
必填/选填
描述
示例
数据源标识符
必填
数据源的标识符,需保证全局唯一(包括公有数据源和私有数据源)。填写最多 100 位字符串。
SolarAPI
数据源名称
必填
数据源的名称。填写最多 100 位字符串。
Solar API
服务地址
必填
数据源的服务地址,通常由传输请求协议和承载 API 服务的服务器域名或 IP 组成。
http://s-solareeop.apaas-cn5.example.com
规约
必填
若数据源来自 EnOS 指标管理,则选择
OLAP
,否则选择标准
。标准
在 接口列表 下,参考以下信息输入需要注册的接口信息。若需注册多个接口,点击 + 添加接口。
分类
字段
必填/选填
描述
示例
基础配置
接口类型
必填
根据接口提供的数据的类型,选择
指标
、累计型测点
、属性
或记录
。同一数据源下,不可添加重复的接口类型,即:每种类型的接口最多只有一个。指标
基础配置
接口请求路径
必填
接口的资源路径,即 API 访问路径。
/solar/metrics
高级配置
HTTP请求方法
必填
接口数据的请求方式,目前支持
GET
或POST
。POST
高级配置
数值转换标记
必填
如果需要通用数据服务对接口查询结果进行 string to number 转换,则启用数值转换标记。
启用
高级配置
接口内容类型
必填
接口发送的内容类型。目前支持
application/x-www-form-urlencoded
和application/json
两种。application/x-www-form-urlencoded
高级配置
服务地址
选填
如果当前 API 接口的服务地址与所属数据源不同,需填写该接口的服务地址。通用数据服务调用该接口时会使用此处填写的地址覆盖所属数据源的服务地址。
/
高级配置
连接超时阈值
必填
若连接时间超过阈值,则判定为连接超时。填写一个大于 0 的数字,单位
ms
,默认值为 10000。10000
高级配置
请求超时阈值
必填
若请求时间超过阈值,则判定为请求超时。填写一个大于 0 的数字,单位
ms
,默认值为 30000。30000
高级配置
慢请求阈值
必填
若请求时间超过阈值,则判定为慢请求。填写一个大于 0 的数字,单位
ms
,默认值为 15000。15000
高级配置
失败请求率熔断阈值
必填
若失败请求的比例超过阈值,则触发熔断机制。填写一个大于 0、小于或等于 100 的数字,单位
%
,默认值为 50。50
高级配置
慢请求率熔断阈值
必填
若慢请求的比例超过阈值,则触发熔断机制。填写一个大于 0、小于或等于 100 的数字,单位
%
,默认值为 50。50
备注
通用数据服务在查询多源数据时,为了避免单源不可用或低性能问题对其他源的数据返回产生影响,会对异常数据源采取熔断机制。其实现方式是,以数据源 API 为统计单元,以某数据源 API 的最近 100 次调用为统计范围,统计慢请求数(慢请求是指请求时长超过慢请求阈值的请求)。
如果慢请求率超过慢请求率熔断阈值或者失败率超过失败请求率熔断阈值,则通用数据服务触发熔断机制,停止该数据源 API 的服务调用 1 分钟。
1 分钟后通用数据服务将恢复该数据源 API 服务到半开状态,允许 10 个请求,如果此时熔断条件不满足,则熔断结束,否则继续熔断一分钟。
通用数据服务熔断机制仅作用于数据源 API,对于一次请求中访问多个数据源 API 且部分出现熔断的情况,其他数据源 API 提供的数据仍能通过通用数据服务正常返回,不受熔断影响。
所有信息填写完成后,点击 提交。
结果¶
注册成功后,数据源出现在数据源列表中。应用构建者可以查看数据源详情,并进行以下操作:
修改数据源:点击对应数据源行的 编辑 。
删除数据源:点击对应数据源行的 删除 。数据源删除后不可恢复。