1. 下行分发服务

API列表

编号 API名称 路径 版本 动作
1.1 边缘主动拉取数据的下行响应 /dispatcher/up/raw/reply 1.0 设备pub
1.2 边缘agent下行透传（同步） /dispatcher/sync/transport/{projectId}/down/raw/product/{templateId} 1.0 云端下发
1.3 边缘agent下行透传（异步） /dispatcher/async/transport/{projectId}/down/raw/product/{templateId} 1.0 云端下发
1.4 边缘车场下行透传（同步） /dispatcher/sync/parkingLot/{projectId}/down/raw/parking/{parkingLotId} 1.0 云端下发
1.5 边缘车场下行透传（异步） /dispatcher/async/parkingLot/{projectId}/down/raw/parking/{parkingLotId} 1.0 云端下发
1.6 边缘配置下行透传（同步） /dispatcher/sync/config/down/raw/{projectId} 1.0 云端下发
1.7 边缘配置下行透传（异步） /dispatcher/async/config/down/raw/{projectId} 1.0 云端下发

API调用

1.1: 边缘主动拉取数据的下行响应

描述 边缘端收到拉取数据请求后,下发响应调用的接口

请求信息

HTTP协议：HTTP,HTTPS

uri：/dispatcher/up/raw/reply

方法：POST

请求参数

名称 位置 类型 必填 描述
session body object y 从接入层带上来的session信息
connectorId session String y 从接入层带上来的session信息
channelId session String y 从接入层带上来的会话channel信息
clientId session String y 从接入层带上来的会话clientId信息
appKey session String y 从接入层带上来的会话appKey信息
projectId session String y 从接入层带上来的会话projectId信息
payload body object y 下发的payload信息
requestId payload String y 请求ID
method payload String y 下发的method信息
data payload object y 下发的数据信息
timestamp payload long y 时间戳
topic body String y 下发到边端的topic

请求Body描述(Form表单)

{
   "session": {
          "connectorId": "iot-gateway-acceptor_172.16.1.200_1883",
           "channelId": "d5d241ff",
           "clientId": "DEF1D5D2-C4E5-498A-BB81-94441CD9032A",
           "appKey": "0RFMTExNzUzMzg3QUU1MUJGQzk",
           "projectId": "Q0ExQTNCRjc5R"
   },
   "topic": "/gateway/asdasd/manage-service_192.168.1.1_200/up_raw_reply",
   "payload": {
         "requestId": "d479a9cfaa7af92b5d694bda14f3d092",
         "method": "device.delete",
         "data":[{"deviceId": "13123"}],
         "timestamp": 123123123123
    }
}

返回信息

返回参数类型

JSON

返回参数

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

1.2: 边缘agent下行透传（同步）

描述： 同步下发设备控制指令

请求信息

HTTP协议：HTTP,HTTPS

uri：/dispatcher/sync/transport/{projectId}/down/raw/product/{templateId}

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId uri String y 项目ID
templateId uri String y 设备模板ID
payload body object y 下发的payload信息
requestId payload String y 请求ID
method payload String y 下发的method信息
data payload object y 下发的数据信息
timestamp payload long y 时间戳
topic body String y 下发到边端的topic

请求Body描述(Form表单)

{
   "requestId": "d479a9cfaa7af92b5d694bda14f3d092",
   "timestamp": 13123123123,
   "payload": {
       "method": "device.delete",
       "data":[{"deviceId": "13123"}]
    }
}

返回信息

返回参数类型

JSON

返回参数

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

1.3: 边缘agent下行透传（同步）

描述： 异步下发设备控制指令

请求信息

HTTP协议：HTTP,HTTPS

uri：/dispatcher/async/transport/{projectId}/down/raw/product/{templateId}

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId uri String y 项目ID
templateId uri String y 设备模板ID
payload body object y 下发的payload信息
requestId payload String y 请求ID
method payload String y 下发的method信息
data payload object y 下发的数据信息
timestamp payload long y 时间戳
topic body String y 下发到边端的topic

请求Body描述(Form表单)

{
   "requestId": "d479a9cfaa7af92b5d694bda14f3d092",
   "timestamp": 13123123123,
   "payload": {
       "method": "device.delete",
       "data":[{"deviceId": "13123"}]
    }
}

返回信息

返回参数类型

JSON

返回参数

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

1.4: 边缘车场下行透传（同步）

描述： 同步下发车行业务请求

请求信息

HTTP协议：HTTP,HTTPS

uri：/dispatcher/sync/parkingLot/{projectId}/down/raw/parking/{parkingLotId}

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId uri String y 项目ID
parkingLotId uri String y 车场ID
timestamp body long y 时间戳
requestId body String y 请求ID
payload body object y 下发的payload信息
method payload String y 下发的method信息
data payload object y 下发的数据信息

请求Body描述(Form表单)

{
   "requestId": "d479a9cfaa7af92b5d694bda14f3d092",
   "timestamp": 13123123123,
   "payload": {
       "method": "device.delete",
       "data":[{"deviceId": "13123"}]
    }
}

返回信息

返回参数类型

JSON

返回参数

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

1.5: 边缘车场下行透传（异步）

描述： 异步下发车行业务请求

请求信息

HTTP协议：HTTP,HTTPS

uri：/dispatcher/async/parkingLot/{projectId}/down/raw/parking/{parkingLotId}

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId uri String y 项目ID
parkingLotId uri String y 设备模板ID
timestamp body long y 时间戳
requestId body String y 请求ID
payload body object y 下发的payload信息
method payload String y 下发的method信息
data payload object y 下发的数据信息

请求Body描述(Form表单)

{
   "requestId": "d479a9cfaa7af92b5d694bda14f3d092",
   "timestamp": 13123123123,
   "payload": {
       "method": "parking.charge.result",
       "data":[{"deviceId": "13123"}]
   }
}

返回信息

返回参数类型

JSON

返回参数

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

1.6: 边缘配置下行透传（同步）

描述： 同步下发配置数据

请求信息

HTTP协议：HTTP,HTTPS

uri：/dispatcher/sync/config/down/raw/{projectId}

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId uri String y 项目ID
requestId payload String y 请求ID
timestamp payload long y 时间戳
payload body object y 下发的payload信息
method payload String y 下发的method信息
data payload object y 下发的数据信息

请求Body描述(Form表单)

{
   "requestId": "d479a9cfaa7af92b5d694bda14f3d092",
   "timestamp": 13123123123,
   "payload": {
       "method": "template.rule.push",
       "data":[{"deviceId": "13123"}]
    }
}

返回信息

返回参数类型

JSON

返回参数

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

1.7: 边缘配置下行透传（异步）

描述： 控制agent

请求信息

HTTP协议：HTTP,HTTPS

uri：/dispatcher/async/config/down/raw/{projectId}

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId uri String y 项目ID
requestId body String y 请求ID
timestamp body long y 时间戳
payload body object y 下发的payload信息
method payload String y 下发的method信息
data payload object y 下发的数据信息

请求Body描述(Form表单)

{
   "requestId": "d479a9cfaa7af92b5d694bda14f3d092",
   "timestamp": 13123123123,
   "payload": {
       "method": "template.rule.push",
       "data":[{"deviceId": "13123"}]
    }
}

返回信息

返回参数类型

JSON

返回参数

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

results matching ""

    No results matching ""