即时命令-写设备资源
请求方式:POST
URL: http://API_ADDRESS/nbiot
url参数
参数名称 |
格式 |
是否必须 |
说明 |
imei |
string |
是 |
nbiot设备的身份码 |
obj_id |
int |
是 |
设备的object id,根据终端设备sdk确定 |
obj_inst_id |
int |
是 |
nbiot设备object下具体的一个实例id,根据终端设备sdk确定 |
mode |
int |
是 |
write的模式,只能是1或者2 |
timeout |
int |
否 |
请求超时时间,默认25(单位:秒),取值范围[5, 40] |
http请求参数
参数名称 |
格式 |
是否必须 |
说明 |
data |
array-json |
是 |
写设备资源的json数组,大小限制2k,见data请求参数描述表 |
data描述表
参数名称 |
格式 |
是否必须 |
说明 |
res_id |
int |
是 |
指定write操作的资源id |
type |
int |
否 |
目前支持为1 和 2,1代表该资源type为Opaque,此时val字段为该二进制对应的十六进制字符串;2代表该资源type为Time,此时val字段为时间戳(单位为秒,数值);不写代表该资源type为基础数据类型 |
val |
object |
是 |
根据指定资源的类型决定val的数值类型,可为boolean、string、long、double |
返回参数
参数名称 |
格式 |
说明 |
errno |
int |
调用错误码,为0表示调用成功 |
error |
string |
错误描述,为"succ"表示调用成功 |
说明
返回errno状态码所对应的含义,可以在OneNET文档中心->设备开发指南->协议文档->LWM2M中《NB协议北向api返回状态码说明》下载查看
mode取值: 1 ,表示replace ,意为替换指定的instance或者resource的值 ; 2,表示partial update , 意为只更新给定的resource或者resource instace的值
请求示例
POST http://API_ADDRESS/nbiot HTTP/1.1
api-key: WhI*************v1c=
Content-Type: application/json
Host: API_ADDRESS
请求参数示例
非opaque类型:
{
"data":[
{
"res_id":12,
"val":121
}
]
}
opaque类型:
{
"data":[
{
"res_id":12,
"type":1,
"val":121
}
]
}
返回示例
{
"errno": 0,
"error": "succ"
}