Person Group - Get a Person Group 检索person group的信息，包括其名称和用户数据。此API仅返回person group信息，使用person group中的人员列表人员而不是person group中的人员信息 Http Method `GET` Request URL `https://api.cognitive.azure.cn/face/v1.0/persongroups/{personGroupId} ` Request parameters | 参数名|参数类型 |描述 | | --- | --- | --- | | personGroupId |string | 目标person group的personGroupId| 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 成功的通话将返回personGroup的信息. JSON fields in response body | Fields | Type | Description | | --- | --- | --- | | personGroupId | String| 请求参数中提供的目标personGroupId | | name | String | personGroup显示名称| | userData | String | 附加到此personGroup用户提供的数据 | ~~~ { "personGroupId": "sample_group", "name": "group1", "userData":"User-provided data attached to the person group" } ~~~ 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 通话量配额。配额将在2.12天内补充 ~~~ { "error":{ "statusCode": 403, "message": "Out of call volume quota. Quota will be replenished in 2.12 days." } } ~~~ Response 404 | Error Code | Error Message Description | | --- | --- | | PersonGroupNotFound | PersonGroupNotFound PersonGroupID无效。有效格式应该是由数字组成的字符串，英文字母小写，' - '，'_'，不超过64个字符 | | PersonGroupNotFound | 找不到PersonGroup | ~~~ { "error":{ "code":"PersonGroupNotFound", "message":"Person group 'sample_group' is not found." } } ~~~ Response 409 有资源的sample_group '冲突操作，请稍后再试 ~~~ { "error":{ "code": ConcurrentOperationConflict, "message": "There is a conflict operation on resource 'sample_group', please try later." } } ~~~ Response 429 超出速率限制。26秒后再试一次。 ~~~ { "error":{ "statusCode": 429, "message": "Rate limit is exceeded. Try again in 26 seconds." } } ~~~