查询所有人脸库
URI
GET /v2/{project_id}/face-sets
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参见获取项目ID/账号名/AK/SK。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,响应消息头中X-Subject-Token的值即为Token。 |
Content-Type |
是 |
String |
发送的实体的MIME类型,参数值为“application/json”。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
face_sets_info |
Array of FaceSetInfo objects |
人脸库信息集合,详见FaceSetInfo。 调用失败时无此字段。 |
参数 |
参数类型 |
描述 |
---|---|---|
face_number |
Integer |
人脸库中已有的人脸特征的数量。 |
external_fields |
Object |
用户的自定义字段。 |
face_set_id |
String |
人脸库ID,随机生成的包含八个字符的字符串。 |
face_set_name |
String |
人脸库名称。 |
create_date |
String |
创建时间。 |
face_set_capacity |
Integer |
人脸库最大的容量。创建人脸库时,请求参数如果不设置face_set_capacity参数,默认每个人脸库最大容量为10万个人脸特征。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
调用失败时的错误码。 调用成功时无此字段。 |
error_msg |
String |
调用失败时的错误信息。 调用成功时无此字段。 |
请求示例
X-Auth-Token值获取方法请参见认证鉴权。
- 请求样例
GET https://{endpoint}/v2/{project_id}/face-sets Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDT...
响应示例
状态码:200
{ "face_sets_info": [ { "face_number": 0, "face_set_id": "ylXMMZTO", "face_set_name": "test", "create_date": "2018-05-11 07:49:40", "face_set_capacity": 100000, "external_fields": { "number": { "type": "integer" }, "id": { "type": "string" }, "timestamp": { "type": "long" } } } ] }
状态码:400
{ "error_code": "FRS.0002", "error_msg": "The authentication token is abnormal." }
状态码
状态码请参见状态码。
错误码
错误码请参见错误码。