文档首页/ 人脸识别服务 FRS/ API参考/ API/ 人脸资源管理/ 删除人脸
更新时间：2024-04-19 GMT+08:00
查看PDF
分享

删除人脸

功能介绍

根据指定字段删除人脸库中人脸。

前提条件：

请确保您已开通人脸识别服务，具体操作方法请参见申请服务。

URI

DELETE /v2/{project_id}/face-sets/{face_set_name}/faces?field_name=field_value

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参见获取项目ID/账号名/AK/SK。

face_set_name

String

是

人脸库名称。

field_name

String

是

按条件删除的字段名，支持固定字段（external_image_id和face_id），以及用户的自定义字段（不支持空字符串和null值删除）。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，响应消息头中X-Subject-Token的值即为Token。

Content-Type

是

String

发送的实体的MIME类型，参数值为“application/json”。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

face_number

Integer

删除的人脸数量。 调用失败时无此字段。

face_set_id

String

人脸库ID。 调用失败时无此字段。

face_set_name

String

人脸库名称。 调用失败时无此字段。

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

调用失败时的错误码。 调用成功时无此字段。

error_msg

String

调用失败时的错误信息。 调用成功时无此字段。

请求示例

X-Auth-Token值获取方法请参见认证鉴权。

  • 请求样例（方式一：使用external_image_id删除） 
    DELETE https://{endpoint}/v2/{project_id}/face-sets/showFaceSet/faces?external_image_id=imageID
Request Header:
Content-Type: application/json
X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDT...
  • 请求样例（方式二：使用face_id删除） 
    DELETE https://{endpoint}/v2/{project_id}/face-sets/showFaceSet/faces?face_id=faceID
Request Header:
Content-Type: application/json
X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDT...
  • 请求样例（方式三：自定义字段删除） 
    DELETE https://{endpoint}/v2/{project_id}/face-sets/showFaceSet/faces?id=home
Request Header:
Content-Type: application/json
X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDT...

响应示例

状态码：200

成功响应样例 
{
  "face_number": 1,
  "face_set_id": "T785tx1N",
  "face_set_name": "showFaceSet"
}

状态码：400

失败响应样例 
{
  "error_code": "FRS.0402",
  "error_msg": "External id is not exist, can not delete face"
}
父主题： 人脸资源管理