1. 数据网关
1.1. 数据网关的数据结构
字段 | 类型 | 描述 |
---|---|---|
id | LONG | 数据网关对象 id |
title | STRING | 数据网关名字 |
enable | BOOL | 数据网关是否启用 |
1.2. 接口说明
1.2.1. 新增数据网关
请求
POST /api/data-gateways
请求参数
request body 参数
返回对象格式
字段 | 类型 | 说明 |
---|---|---|
data | OBJECT | 见数据网关的数据结构 |
接口示例
- 请求
POST /api/data-gateways
{
"title":"dgw3"
}
- 返回
{
"version": "3.3-SNAPSHOT@null#null",
"code": 0,
"msg": "success",
"data": {
"id": 4,
"title": "dgw3"
"enable": true
}
}
1.2.2. 获取数据网关列表
说明: 仅能获取用户自己建立的数据网关
请求
GET /api/data-gateways
请求参数
无
返回对象格式
字段 | 类型 | 说明 |
---|---|---|
data | OBJECT | 见数据网关的数据结构 |
接口示例
- 请求
GET /api/data-gateways
- 返回
{
"version": "3.3-SNAPSHOT@null#null",
"code": 0,
"msg": "success",
"data": [
{
"id": 2,
"title": "dgw2",
"enable": true
},
{
"id": 1,
"title": "dgw1.1",
"enable": false
},
{
"id": 4,
"title": "dgw3",
"enable": true
}
]
}
1.2.3. 修改数据网关对象
请求
PUT /api/data-gateways/{dataGatewayId}
request body 参数
返回对象格式
字段 | 类型 | 说明 |
---|---|---|
data | OBJECT | 见数据网关的数据结构 |
接口示例
- 请求
PUT /api/data-gateways/1
{
"title":"dgw1.2"
}
- 返回
{
"version": "3.3-SNAPSHOT@@git.commit.id.abbrev@#null",
"code": 0,
"msg": "success",
"data": {
"id": 1,
"title": "dgw1.2"
}
}
1.2.4. 删除数据网关对象
请求
DELETE /api/data-gateways/{dataGatewayId}
request body 参数
无
返回对象格式
无
接口示例
- 请求
DELETE /api/data-gateways/1
- 返回
{
"version": "3.3-SNAPSHOT@@git.commit.id.abbrev@#null",
"code": 0,
"msg": "success"
}
1.2.5. 下载客户端压缩包
请求
GET /api/data-gateways/{dataGatewayId}/clientpkg
请求参数
无
返回对象格式
压缩包文件内容
1.2.6. 下载客户端配置文件
请求
GET /api/data-gateways/{dataGatewayId}/clientconfig
请求参数
无
返回对象格式
data-gateway-xxx.json 文件内容