门禁API-查询门禁设备列表

路径 /entrance/paas/subdevice/list
版本号 1.0.0
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权
超时时间 3000

请求参数

名称 类型 是否必选 示例值 描述
queryInfo Struct 查询条件
gatewayProductKey String 边缘网关设备PK
gatewayDeviceName String 边缘网关设备DN
gatewayIotId String 边缘网关设备ID
pageSize Int 每页数据条数
pageNo Int 页码

返回数据

名称 类型 示例值 描述
code Int

响应码, 200: 成功

message String

错误消息

localizedMsg String

本地语言错误消息

data JSON

设备列表

total Long

数据总条数

pageSize Int

每页数据条数

pageNo Int

页码

data JSON

门禁设备列表

subProductKey String

门禁设备PK

subDeviceId String

门禁设备名称

subIotId String

门禁设备ID

gatewayProductKey String

边缘网关设备PK

gatewayDeviceName String

边缘网关设备DN

gatewayIotId String

边缘网关设备ID

direction String

门禁方向:ENTRANCE(入);EXIT(出)

extInfo String

设备扩展信息

ip String

ip地址

port Int

端口

subDeviceName String

门禁设备DN

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.0"
	},
	"params":{
		"queryInfo": "value0"
	}
}

正常返回示例

JSON 格式

{
    "code": 200,
    "message": "success",
    "localizedMsg": "success",
    "data": {
    "total": 1,
    "pageSize":10,
    "pageNo":1,
    "data": [{
			"edgeCellId": 194702,
			"gatewayIotId": "n4rQ8opgihUitsQQynpp******",
			"ip": "192.168.50.16",
			"subDeviceId": "daily",
			"gmtCreate": 1559632119000,
			"extInfo": "extInfo",
			"port": 1234,
			"subDeviceName": "eg_dailn4rQ8opgihUits******",
			"subProductKey": "a1v7H5******",
			"id": 10,
			"gatewayProductKey": "a1ygw******",
			"gatewayDeviceName": "n4rQ8opgihUits******",
			"class": "com.aliyun.iotx.campuslink.edge.entranceguard.api.dto.EntranceDeviceDTO",
			"subIotId": "pTFsaPhwEqZWVvazj8aH******",
			"direction": "ENTRANCE"
		}]
  }
}

异常返回示例

JSON 格式

{
    "code":403,
    "message":"request forbidden.",
    "localizedMsg":"请求被禁止"
}

错误码

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 2459 oa error message 会话Id不存在
200 2459 oa error message 会话Id不存在
200 2401 refreshToken invalid refreshToken已经失效
200 2401 refreshToken invalid refreshToken已经失效
200 460 identityIds need between 1-50 入参错误
200 460 identityIds need between 1-50 入参错误
200 460 identityIds need between 1-50 入参错误
200 460 identityIds need between 1-50 入参错误
200 403 request forbidden. 请求被禁止
200 2407 openId invalid openId invalid
200 403 request forbidden. 请求被禁止
200 2407 openId invalid openId invalid
200 403 request forbidden. 请求被禁止
200 2407 openId invalid openId invalid
200 403 request forbidden. 请求被禁止
200 403 request forbidden. 请求被禁止
200 2486 access refresh token expired accessToken或者 refreshToken已经过期
200 403 request forbidden. 请求被禁止
200 460 request parameter error. 入参不正确
200 403 request forbidden 访问被禁止
200 460 dingdingbind employee not exist 请求参数错误
200 2442 employee is not exist 未找到绑定的员工信息
200 403 request forbidden 访问被禁止
200 460 dingdingbind employee not exist 请求参数错误
200 2442 employee is not exist 未找到绑定的员工信息
200 403 request forbidden. 请求被禁止
200 2441 employee is already existed 该员工已经存在
200 4020 invalid smscode 手机验证码无效