Help Center> Face Recognition Service> API Reference> APIs> Facial Resource Management> Deleting Faces in Batches
Updated on 2023-04-25 GMT+08:00
View PDF

Deleting Faces in Batches

Function

This API is used to batch delete multiple faces that meet specified criteria you customize.

Prerequisites:

Ensure that you have enabled FRS. For detailed operations, see Applying for FRS.

Use standard JSON format in the body of the application/json request.

URI

DELETE /v2/{project_id}/face-sets/{face_set_name}/faces/batch

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the ID, see Obtaining the Project ID/Account Name/AK/SK.

face_set_name

String

Yes

Name of a facial image library.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

During API authentication using a token, the token is added to requests to obtain permissions for calling the API. The value of X-Subject-Token in the response header is the obtained token.

Content-Type

Yes

String

MIME type of the request body. The value is application/json.
Table 3 Request body parameters

Parameter

Type

Mandatory

Description

filter

String

Yes

Filtering criteria. For details, see Filter Syntax.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

face_number

Integer

Number of deleted faces. This parameter is not included when the API fails to be called.

face_set_id

String

ID of the facial image library. This parameter is not included when the API fails to be called.

face_set_name

String

Name of the facial image library. This parameter is not included when the API fails to be called.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code when calling the API failed. This parameter is not included when the API is successfully called.

error_msg

String

Error message returned after the API fails to be called. This parameter is not included when the API is successfully called.

Example Requests

For details about how to obtain the value of X-Auth-Token, see Authentication.

  • Example request (Use filter to batch delete faces.)
    DELETE https://{endpoint}/v2/{project_id}/face-sets/showFaceSet/faces/batch
Request Header:
Content-Type: application/json
X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDT...

Request Body:
{
  "filter" : "age:[20 TO 30]"
}

Example Responses

Status code: 200

Response example (successful request) 
{
  "face_number": 1,
  "face_set_id": "T785tx1N",
  "face_set_name": "showFaceSet"
}

Status code: 400

Example response (failed request) 
{
  "error_code": "FRS.0407",
  "error_msg": "All the data not suitable, no data to be deleted."
}

Status Code

For details about the status code, see Status Codes.

Error Code

For details about the error code, see Error Codes.