更新人脸
功能介绍
根据人脸ID(face_id)更新单张人脸信息。
前提条件:
application/json请求的body中,请使用标准Json格式。
URI
PUT /v2/{project_id}/face-sets/{face_set_name}/faces
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参见获取项目ID/账号名/AK/SK。 |
face_set_name |
String |
是 |
人脸库名称。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,响应消息头中X-Subject-Token的值即为Token。 |
Content-Type |
是 |
String |
发送的实体的MIME类型,参数值为“application/json”。 |
参数名 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|
face_id |
String |
是 |
人脸ID,由系统内部生成的唯一ID。 |
external_image_id |
String |
否 |
用户指定的图片外部ID,与当前图像绑定。用户没提供,系统会生成一个。该ID长度范围为1~36位,可以包含字母、数字、中划线或者下划线,不包含其他的特殊字符。 这里是待修改的参数,external_image_id和external_fields至少选一个。 |
external_fields |
Object |
否 |
自定义字段的key值长度范围为[1,36],string类型的value长度范围为[1,256],具体参见自定义字段。 这里是待修改的参数,external_image_id和external_fields至少选一个。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
face_number |
Integer |
更新的人脸数量。 调用失败时无此字段。 |
face_set_id |
String |
人脸库ID。 调用失败时无此字段。 |
face_set_name |
String |
人脸库名称。 调用失败时无此字段。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
调用失败时的错误码。 调用成功时无此字段。 |
error_msg |
String |
调用失败时的错误信息。 调用成功时无此字段。 |
请求示例
X-Auth-Token值获取方法请参见认证鉴权。
- 请求样例
PUT https://{endpoint}/v2/{project_id}/face-sets/showFaceSet/faces Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDT... Request Body: { "face_id": "iexEBb6t", "external_image_id": "imageID", "external_fields": { "timestamp": 12, "id": "300018629384756" } }
响应示例
状态码:200
{ "face_number": 1, "face_set_id": "T785tx1N", "face_set_name": "showFaceSet" }
状态码:400
{ "error_code": "FRS.0303", "error_msg": "The face id is not exist, checkout your input." }
状态码
状态码请参见状态码。
错误码
错误码请参见错误码。