1. 边缘网关API

API列表

编号 API名称 路径 版本
1.1 透传上行接口(同步) /v1/edge/gateway/sync/publishMessage 1.0
1.2 透传上行接口(异步) /v1/edge/gateway/async/publishMessage 1.0
1.3 注册设备 /v1/edge/gateway/registerInstance 1.0

API调用

1.1: 透传上行接口(同步)

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/edge/gateway/sync/publishMessage

方法：POST

名称 位置 类型 必填 描述

请求参数

名称 位置 类型 必填 描述
instanceId body string y 实例id
payload body JSONObject y 载体数据
requestId payload string y requestId
method payload string y 方法
data payload JSONObject y 数据信息
timestamp payload long y 时间戳

请求Body描述(非Form表单数据)

{
    "instanceId": "gateway-links-clienttest_120.0.0.1_8066",
    "payload": {
        "requestId": "1234",
        "method": "device.delete",
        "data": [{"deviceId": "123"}],
        "timestamp": 123456789
    }
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
success 顶层 boolean 是 是否成功
message 顶层 STRING 是 响应消息文本
data 顶层 boolean 是 响应数据对象
返回结果示例
{
    "code": "0",
    "success": true,
    "msg": null,
    "data": true
}
{
    "code": "500",
    "success": false,
    "message": "执行同步推送数据超时",
    "data": null
}

1.2: 透传上行接口(异步)

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/edge/gateway/async/publishMessage

方法：POST

名称 位置 类型 必填 描述

请求参数

名称 位置 类型 必填 描述
instanceId body string y 实例id
payload body JSONObject y 载体数据
requestId payload string y requestId
method payload string y 方法
data payload JSONObject y 数据信息
timestamp payload long y 时间戳

请求Body描述(非Form表单数据)

{
    "instanceId": "gateway-links-clienttest_120.0.0.1_8066",
    "payload": {
        "requestId": "1234",
        "method": "device.delete",
        "data": [{"deviceId": "123"}],
        "timestamp": 123456789
    }
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
success 顶层 boolean y 是否成功
message 顶层 STRING y 响应消息文本
data 顶层 boolean y 响应数据对象
返回结果示例
{
    "code": "0",
    "success": true,
    "message": null,
    "data": true
}

1.3: 注册设备

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/edge/gateway/registerInstance

方法：POST

名称 位置 类型 必填 描述

请求参数

名称 位置 类型 必填 描述
serviceId body string y 服务id
serviceName body string y 服务名
serviceVersion body string y 服务版本号
serviceVersionId body string y 服务版本号id
type data string y 实例类型
templateId data string n 模板id
templateCategory data string n 模板分类
parkingLots data JSONArray n 停车场

请求Body描述(非Form表单数据)

{
    "serviceId":"gateway-links-clienttest_10.73.160.68_8066",
    "serviceName":"gateway-links-clienttest|111222333",
    "serviceVersion":"v1.0",
    "serviceVersionId":"6e2bce88e78c41a6b7fe9d47e54bf137",
    "type":"gateway",
    "templateId": "d479a9cfaa1434g1314bda14f3d092",
    "templateCategory": "smart-parking-lot",
    "parkingLots": ["12313","123123"]
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 boolean 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {}
}

results matching ""

    No results matching ""