数据网关

数据网关的数据结构

字段	类型	描述
id	LONG	数据网关对象 id
title	STRING	数据网关名字
enable	BOOL	数据网关是否启用

接口说明

新增数据网关

请求

POST /api/data-gateways HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数

request body 参数

数据网关的数据结构

返回对象格式

字段	类型	说明
data	OBJECT	见数据网关的数据结构

接口示例

Request

POST /api/data-gateways HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

// Request Body:
{
  "title":"dgw3"
}

Response

HTTP/1.1 200 Ok
Content-Type: application/json

{
  "version": "version@9a5e106#6730f0d",
  "code": 0,
  "msg": "success",
  "data": {
    "id": 4,
    "title": "dgw3"
    "enable": true
  }
}

获取数据网关列表

说明

仅能获取用户自己建立的数据网关

请求

GET /api/data-gateways HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数

无

返回对象格式

字段	类型	说明
data	OBJECT	见数据网关的数据结构

接口示例

Request

GET /api/data-gateways HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

Response

HTTP/1.1 200 Ok
Content-Type: application/json

{
  "version": "version@9a5e106#6730f0d",
  "code": 0,
  "msg": "success",
  "data": [
    {
      "id": 2,
      "title": "dgw2",
      "enable": true
    },
    {
      "id": 1,
      "title": "dgw1.1",
      "enable": false
    },
    {
      "id": 4,
      "title": "dgw3",
      "enable": true
    }
  ]
}

修改数据网关对象

请求

PUT /api/data-gateways/{dataGatewayId} HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

request body 参数

数据网关的数据结构

返回对象格式

字段	类型	说明
data	OBJECT	见数据网关的数据结构

接口示例

Request

PUT /api/data-gateways/1 HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

// Request Body:
{
  "title":"dgw1.2"
}

Response

HTTP/1.1 200 Ok
Content-Type: application/json

{
  "version": "version@9a5e106#6730f0d",
  "code": 0,
  "msg": "success",
  "data": {
    "id": 1,
    "title": "dgw1.2"
  }
}

删除数据网关对象

请求

DELETE /api/data-gateways/{dataGatewayId} HTTP/1.1

request body 参数

无

返回对象格式

无

接口示例

Request

DELETE /api/data-gateways/1 HTTP/1.1

Response

HTTP/1.1 200 Ok
Content-Type: application/json

{
  "version": "version@9a5e106#6730f0d",
  "code": 0,
  "msg": "success"
}

下载客户端压缩包

请求

GET /api/data-gateways/{dataGatewayId}/clientpkg HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate, br, zstd
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数

无

返回对象格式

HTTP/1.1 200 Ok
Content-Disposition: attachment;filename=data-gateway-w.zip
Content-Type: application/zip;charset=UTF-8

data-gateway-w.zip

下载客户端配置文件

请求

GET /api/data-gateways/{dataGatewayId}/clientconfig HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate, br, zstd
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数

无

返回对象格式

data-gateway-xxx.json 文件内容

HTTP/1.1 200 Ok
Content-Disposition: attachment;filename=data-gateway-w.json
Content-Encoding: gzip
Content-Type: text/plain;charset=UTF-8

data-gateway-w.json