文档

基于时间窗口绑定设备

更新时间:
一键部署

调用该接口根据产品配置的绑定时间窗口(默认1800秒)校验并绑定设备。时间窗口从设备上线开始计算。

路径 /vision/user/bind/bytimewindow
版本号 1.0.1
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权
超时时间 10000

请求参数

名称

类型

是否必选

示例值

描述

productKey String a1BwAGV**** 产品ProductKey
deviceName String light 设备名称
iotId String 1O4YPNtRqB2anumz2Canp4GB7q**** 设备IotId
bindSubDevices Boolean 是否绑定子设备,对网关设备有效。true:绑定网关的子设备;false:仅绑定网关

返回数据

名称

类型

示例值

描述

code Int

结果状态码。200:成功

message String

错误码信息

localizedMsg String

本地语言的错误信息

data JSON

返回结果

iotId String

设备IotId

subDeviceIotIdList JSON

绑定的子设备IotId列表

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.1",
		"iotToken": "token"
	},
	"params":{
		"productKey": "a1BwAGV****",
		"deviceName": "light",
		"iotId": "1O4YPNtRqB2anumz2Canp4GB7q****",
		"bindSubDevices": "value3"
	}
}

正常返回示例

JSON格式

{
    "id": "4de2c367-c1db-417c-aa15-8c585e595d92",
    "code": 200,
    "message": null,
    "localizedMsg": null,
    "data": null
}

异常返回示例

JSON格式

{
    "id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
    "code": 403,
    "message": "request forbidden.",
    "localizedMsg": "请求被禁止",
    "data": null
}

错误码

HttpCode

错误码

错误信息

描述

500 500 Internal Error Internal Error
503 503 Service Unavailable Service Unavailable
403 403 Request Limited Request Limited
401 401 Empty Signature Empty Signature
400 400 Request Format Error Request Format Error
200 20003 Find Backend Error Find Backend Error
200 20004 Backend Service Error Backend Service Error
200 20055 Backend Service Invalid Request Format Error
200 20056 Hsf Invoke Timeout Hsf Invoke Timeout
200 401 Request Authorized Error Request Authorized Error
200 403 Request Forbidden Request Forbidden
200 500 Server Error Server Error
  • 本页导读 (1)
文档反馈