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

查询人脸库 - ShowFaceSet

功能介绍

查询人脸库当前的状态。

前提条件：

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

URI

GET /v2/{project_id}/face-sets/{face_set_name}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

face_set_name

是

String

人脸库名称。

请求参数

表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_set_info

FaceSetInfo object

人脸库信息集合，详见FaceSetInfo。 调用失败时无此字段。

表4 FaceSetInfo

参数

参数类型

描述

face_number

Integer

人脸库当中的人脸数量。

external_fields

Object

用户的自定义字段。

face_set_id

String

人脸库ID，随机生成的包含八个字符的字符串。

face_set_name

String

人脸库名称。

create_date

String

创建时间。

face_set_capacity

Integer

人脸库最大的容量。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

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

error_msg

String

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

请求示例

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

  • 请求样例 
    GET https://{endpoint}/v2/{project_id}/face-sets/showFaceSet
Request Header:
Content-Type: application/json
X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDT...

响应示例

状态码：200

成功响应样例 
{
  "face_set_info": {
    "face_number": 94,
    "face_set_id": "T785tx1N",
    "face_set_name": "showFaceSet",
    "create_date": "2018-05-10 01:44:39",
    "face_set_capacity": 100000,
    "external_fields": {
      "number": {
        "type": "integer"
      },
      "id": {
        "type": "string"
      },
      "timestamp": {
        "type": "long"
      }
    }
  }
}

状态码：400

失败响应样例 
{
  "error_code": "FRS.0202",
  "error_msg": "The service has been freeze."
}

状态码

状态码请参见状态码。

错误码

错误码请参见错误码。