Face List - Get a Face List
获取facelist数据,包括:faceListId,name, userData and faces。faceList仅是faces的列表,并且在Face - Find Similar.是可搜索资源。
Http Method
`GET`
Request URL
`https://api.cognitive.azure.cn/face/v1.0/facelists/{faceListId} `
Request parameters
| 参数 |类型 |描述 |
| --- | --- | --- |
| faceListId | string | 规范字符串包括小写字母,数字,‘—’,‘_’,字符串最大长度是64 |
Request headers
| 请求头 |类型 |描述 |
| --- | --- | --- |
| Ocp-Apim-Subscription-Key | string | Subscription key which provides access to this API. Found in your Cognitive Services accounts. |
Request body
Response 200
请求成功返回face list的信息
| Fields | Type | Description |
| --- | --- | --- |
| faceListId | String| 获取的face list 的faceListId |
| name | String | Face list的显示名字|
| userData | String | 附加在face list上用户提供的数据 |
| persistedFaces | Array | Face list中的faces |
~~~
{
"faceListId": "sample_list",
"name": "list1",
"userData":"User-provided data attached to the face list",
"persistedFaces":[
{
"persistedFaceId":"B8D802CF-DD8F-4E61-B15C-9E6C5844CCBD",
"userData":"User-provided data attached to the face"
},
…
]
}
~~~
Response 401
| Error Code | Error Message Description |
| --- | --- |
| Unspecified | 无效的subscription Key 或user/plan 被冻结 |
~~~
{
"error":{
"code": "Unspecified",
"message": "Access denied due to invalid subscription key. Make sure you are subscribed to an API you are trying to call and provide the right key."
}
}
~~~
Response 403
~~~
{
"error":{
"statusCode": 403,
"message": "Out of call volume quota. Quota will be replenished in 2.12 days."
}
}
~~~
Response 404
| Error Code | Error Message Description |
| --- | --- |
| PersistedFaceListNotFound | 无效的Persisted face list ID |
| PersistedFaceListNotFound | 未定义的Persisted face list |
~~~
{
"error":{
"code":"FaceListNotFound",
"message":"Face list 'sample_list' is not found."
}
}
~~~
Response 409
~~~
{
"error":{
"code": ConcurrentOperationConflict,
"message": "There is a conflict operation on resource 'sample_group', please try later."
}
}
~~~
Response 429
~~~
{
"error":{
"statusCode": 429,
"message": "Rate limit is exceeded. Try again in 26 seconds."
}
}
~~~
- 空白目录
- Face
- Detect
- Find Similar
- Group
- Identify
- Verify
- Face List
- Add a Face to a Face List
- Create a Face List
- Delete a Face from a Face List
- Delete a Face List
- Get a Face List
- List Face Lists
- Update a Face List
- Person
- Add a Person Face
- Create a Person
- Delete a Person
- Delete a Person Face
- Get a Person
- Get a Person Face
- List Persons in a Person Group
- Update a Person
- Update a Person Face
- Person Group
- Create a Person Group
- Delete a Person Group
- Get a Person Group
- Get Person Group Training Status
- List Person Groups
- Train Person Group
- Update a Person Group