通过设备名称、品类名称等条件分页查询设备接口。

路径 /campuslink/iwms/device/pagequery
版本号 1.1.0
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权
超时时间 10000

请求参数

名称 类型 是否必选 示例值 描述
deviceQuery Struct 设备查询条件对象
currentPage Int 当前分页页码
limit Int 分页大小
deviceName String 设备名称
productKey String 产品名称
enableStatus Int 启用状态:[0:未启用][1:已启用]
bindStatus Int 绑定状态:[0:未绑定][1:已绑定]
category String 设备品类名英文编码
spaceId String 空间编号
spacePath String 空间路径

返回数据

名称 类型 示例值 描述
code Int

响应码, 200: 成功

message String

错误消息

localizedMsg String

本地语言错误消息

data JSON

响应结果

currentPage Int

当前分页页码

limit Int

分页大小

total Int

数据总条数

data JSON

分页数据

bindStatus Int

绑定状态:0:未绑定1:已绑定

businessId String

空间业务编号

category String

设备品类名英文编码

categoryName String

设备类型中文名称

categoryUrl String

设备类型正常url图片链接

categoryAbUrl String

设备类型异常url图片链接

deviceData String

设备扩展数据:json格式字符串

coordinates String

坐标

deviceName String

设备名称

enableStatus Int

启用状态:0:未启用1:已启用

iotId String

设备编号

productKey String

产品名称

source String

设备来源:iot:阿里云ib:信息平台设备

spaceId String

空间编号

spacePath String

空间路径

deviceAlias String

设备别名

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.1.0"
	},
	"params":{
		"deviceQuery": "value0"
	}
}

正常返回示例

JSON 格式

{
    "id": "4de2c367-c1db-417c-aa15-8c585e595d92", 
    "code": 200, 
    "message": null, 
    "localizedMsg": null, 
    "data": {
        "currentPage": 1, 
        "data": [
            {
                "bindStatus": 1, 
                "businessId": "example", 
                "category": "example", 
                "categoryName": "example", 
                "coordinates": "example", 
                "deviceName": "example", 
                "enableStatus": 1, 
                "iotId": "example", 
                "productKey": "example", 
                "source": "ib", 
                "spaceId": "example", 
                "spacePath": "example"
            }
        ], 
        "limit": 10, 
        "total": 0
    }
}

异常返回示例

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
200 2402 iotToken not exist iottoken不存在
200 2402 iotToken not exist
200 460 iotToken is blank iotToken为空
200 2402 iottoken invalid iottoken已经失效
200 2401 refreshToken invalid refreshToken已经失效
200 2402 iotToken not exist
200 403 request forbidden. 请求被禁止
200 2477 import thirdaccount failed 导入三方账号失败
200 460 thirdAccountMetaList is blank 三方账号列表为空
200 403 request forbidden. 请求被禁止
200 403 request forbidden. 请求被禁止
200 460 request parameter error. 入参不正确
200 460 identityIds need between 1-50 入参错误
200 403 request forbidden. 请求被禁止
200 2453 app not exist appkey不存在
200 2405 identity is not existed 统一身份id不存在
200 2407 auth identity exception 不存在相应的openId