查询网关下的子设备列表,只返回和网关相同租户的设备

路径 /face/paas/edge/guard/device/query
版本号 1.0.0
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权
超时时间 10000

请求参数

名称 类型 是否必选 示例值 描述
edgeGwIotId String 边缘网关设备iotId。

返回数据

名称 类型 示例值 描述
code Int

响应码, 200: 成功

message String

错误消息

localizedMsg String

本地语言错误消息

data JSON

响应结果

iotId String

网关子设备iotId

productKey String

网关子设备pk

deviceName String

网关子设备名称

categoryKey String

网关子设备分类key

categoryName String

网关子设备分类名称

status Int

子设备状态 0未激活 1 在线 3 离线 8 禁用

示例

请求示例

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

正常返回示例

JSON 格式

{
  "code": 200,
  "data": [{
    "categoryKey": "Facexxxxgnition",
    "categoryName": "人脸识别门禁",
    "deviceName": "xxx",
    "iotId": "xxx",
    "productKey": "xxx",
    "status": 0
  }],
  "message": "success"
}

异常返回示例

JSON 格式

{
  "code": 200,
  "message": "system error"
}

错误码

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. 请求被禁止