设备接入 IOTDA-HTTPS协议接入:设备消息上报接口说明

时间:2024-07-30 14:22:53

设备消息上报接口说明

用于设备将自定义数据上报给平台,平台将设备上报的消息转发给应用服务器或华为云其他云服务上进行存储和处理。

请求方法

POST

URI

/v5/devices/{device_id}/sys/messages/up

传输协议

HTTPS

名称

必选

类型

位置

说明

access_token

String

Header

参数说明: 调用设备鉴权信息返回的access_token。

取值范围: 长度1-256

device_id

String

Path

参数说明: 参数说明:设备ID,用于唯一标识一个设备。在注册设备时直接指定,或者由 物联网平台 分配获得。由物联网平台分配时,生成规则为"product_id" + "_" + "node_id"拼接而成。

取值范围:长度不超过128,只允许字母、数字、下划线(_)、连接符(-)的组合。

取值范围: 长度1-128

该接口支持设备将自定义数据通过请求中的body体上报给平台,平台收到该请求后会将body内容转发给应用服务器或华为云其他云服务上进行存储和处理。平台对body中的内容无具体格式限制,小于1MB的数据可以通过该接口携带。

请求示例如下:

POST https://{endpoint}/v5/devices/{device_id}/sys/messages/up
Content-Type: application/json
access_token: ********
{
  "name" : "name",
  "id" : "id",
  "content" : "messageUp"
}

响应示例如下:

Status Code: 200 ok

HTTP状态码

HTTP状态码描述

错误码

错误码描述

错误码中文描述

200

OK

-

-

-

400

Bad Request

IOTDA.000006

Invalid input data.

请求参数不合法

401

Unauthorized

IOTDA.000002

Authentication failed.

鉴权失败

403

Forbidden

IOTDA.000004

Invalid access token.

非法token

IOTDA.021101

Request reached the maximum rate limit.

请求已经达到限制速率

IOTDA.021102

The request rate has reached the upper limit of the tenant, limit %s.

请求已经达到租户的限制速率

support.huaweicloud.com/usermanual-iothub/iot_01_00129.html