接入文档
人脸搜索（海外版）
API接入
删除人脸库
删除人脸库
# 描述
此接口提供删除指定的人脸库的功能。
调用URL：
https://api-sgp.yljz.com/finauth/search/group/free
# 请求参数
| 参数名 | 类型 | 参数说明 | |
|---|---|---|---|
| 必选 |
sign | String | 调用此API客户的签名，具体的签名产生方式请查阅App-鉴权说明 |
| 必选 | sign_version | String | 签名算法版本，请传递：hmac_sha1 |
| 必选 | group_id | String | 用户提供的人脸库标识 |
| 可选 | check_empty |
Int |
删除时是否检查人脸库中是否存在人脸数据，默认值为1 0：不检查 1：检查 如果设置为1，当人脸库中存在人脸数据则不能删除 |
# 返回值说明
| 字段 | 类型 | 说明 |
|---|---|---|
| request_id | String | 用于区分每一次请求的唯一的字符串。 |
| time_used | Int | 整个请求所花费的时间，单位为毫秒。 |
| group_id | string | 删除的人脸库标识 |
| error |
String | 当请求失败时才会返回此字符串，具体返回内容见后续错误信息章节。否则此字段不存在。 |
正确请求返回示例
{
"request_id": "1769684764,35b33b50-60ef-47dd-a346-c224ec8a313b",
"time_used": 100,
"group_id": "YuanliStudent_01"
}
错误返回示例
{
"request_id": "1769684828,e483ae63-913b-4e32-9068-3719cce59570",
"time_used": 15,
"error": "INVALID_GROUP_ID"
}
# error_message错误信息
当前API特有ERROR_MESSAGE
| HTTP状态代码 | 错误信息 | 说明 |
|---|---|---|
| 400 | INVALID_OUTER_ID | 人脸库不存在 |
| 400 | NOT_EMPTY | 人脸库不为空，不能删除（设置check_empty=1时） |