批量查询设备属性快照
功能介绍
应用服务器可调用此接口批量查询设备属性快照,单批次最大支持20个设备,此接口提供给smartIT使用。
URI
POST /v1/iotfm/devices/multi-get-properties
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数说明:用户Token。通过调用 生成Token 接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 |
X-Instance-Id |
是 |
String |
参数说明:实例ID。通过访问智能设施云平台界面后获取,智能设施云平台资源均为实例级隔离,所有业务接口必须填写正确的实例ID才能被成功调用。 取值范围:长度8-36,只允许大小写字母、数字和-字符的组合。 |
X-Root-Zone-Id |
否 |
String |
参数说明:项目ID。 取值范围:长度不超过24,只允许字母、数字的组合。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
device_ids |
否 |
Array of strings |
设备ID列表 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
devices_properties |
Array of DeviceReportedProperties objects |
设备属性快照列表 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数说明:错误码。 取值范围:长度8-36。 |
error_msg |
String |
参数说明:错误描述。 取值范围:长度2-512。 |
请求示例
批量查询设备属性快照
POST https://{endpoint}/v1/iotfm/devices/multi-get-properties
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |