注册 Open API 数据源¶
要通过 Open API 的方式接入数据,需要先配置该数据源的信息以及创建与目标 API 服务的连接。
前提条件¶
开始之前,确保以下事项:
当前账号已被分配所需的资产权限、操作权限点和菜单组。如未分配,联系 OU 管理员。
已获取数据源连接配置的详细信息,如服务器 IP 地址,端口号,数据库名称,数据库访问用户名,访问密码等等。
操作步骤¶
登录 EnOS 应用门户,在左侧导航栏中选择 数据 > 数据源注册。
点击 新增数据源。
在 新增数据源 页面,完成以下配置:
基本信息:
数据源类型 (必选):选择 OPENAPI。
数据源名称 (必填):输入数据源的名称。数据源名称的最大长度为 50 个字符,名称可以是以下字符的组合:
中文
a - z
A - Z
0 - 9
_(下划线)
-(短横线)
数据源描述:输入对数据源的描述。描述的最大长度为 100 个字符,支持国际化配置(默认、中文、英文)。
在 配置信息 > 请求设置 一栏中,完成以下 API 服务的请求参数配置:
服务地址 (必填):输入 API 服务的地址,例如
https://{apigw-address}Method (必填):选择 API 请求方式(GET 或 POST)
请求路径 (必填):输入 API endpoint 的路径,例如
/model-service/v2.1/thing-models?action=get请求参数:点击 添加参数,逐个输入和配置 API 的请求参数
在 配置信息 > 返回结果设置 一栏中,完成以下 API 服务的返回参数配置:
Content Type (必选):目前支持选择
application/json;charset=utf-8Success Code (必填):输入成功调用 API 的返回码
Dataset Type (必选):选择数据集类型(object 或 object array)
Dataset (必填):输入数据集
选择 API 鉴权类型(无鉴权或普通 Token 鉴权);若选择 普通 Token 鉴权,需对应地配置 Token 服务、Token 参数、Token 最新间隔。
在 配置信息 > 翻页设置 一栏中,完成以下配置:
翻页类型 : 选择翻页类型(可选:不翻页、 Offset/Limit 翻页、 PageSize/PageNo翻页)
在 配置信息 > 数据获取配置 一栏中,完成以下配置:
时间增量参数 : 选择时间增量参数。
结果¶
数据源注册成功后,该数据源项将显示在 数据源注册 的列表中。用户可查看 OU 内所有数据源的基本信息,仅创建者可修改、删除其所注册数据源。请参阅 管理数据源。