添加/更新人脸门禁到边缘网关,仅适用于边缘的设备。如果人脸门禁设备不存在,创建新的设备;如果人脸门禁设备已经存在,则更新。

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

请求参数

名称 类型 是否必选 示例值 描述
deviceIp String 192.168.1.2 待创建人脸设备的局域网IP地址,格式xxx.xxx.xxx.xxx。
edgeGwIotId String 边缘网关设备ID,创建新设备所在的边缘网关设备ID。
productKey String 待创建人脸设备的pk(tmp三元组中的pk)。
imageOssBucketName String 人脸识别后,图片存放的阿里云oss bucketName,oss需要购买在相同的账号下。
deviceName String 待创建人脸设备的 dn(tmp三元组中dn),如果不传,系统会默认生成deviceName;如果已经在LP创建了设备,可以直接使用已经创建的设备。
imageOssEndPoint String oss接入endpoint默认:http://oss-cn-shanghai.aliyuncs.com。
extInfo String 设备自定义扩展信息,不做加工处理,设备的进出类型通过该字段定义,长度小于128字符。

返回数据

名称 类型 示例值 描述
code Int

响应码, 200: 成功

message String

错误消息

localizedMsg String

本地语言错误消息

data JSON

响应结果

iotId String

人脸门禁设备iotId

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.0"
	},
	"params":{
		"deviceIp": "192.168.1.2",
		"edgeGwIotId": "value1",
		"productKey": "value2",
		"imageOssBucketName": "value3",
		"deviceName": "value4",
		"imageOssEndPoint": "value5",
		"extInfo": "value6"
	}
}

正常返回示例

JSON 格式

{
  "code": 200,
  "data": {
    "iotId": "UcP2qbB*****HaLR0hyNd000"
  },
  "message": "success"
}

异常返回示例

JSON 格式

{
  "code": 500,
  "message": "system errr"
}

错误码

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