Person Group - List Person Groups 可选字符串参数“start”和int参数“top”用于指定返回的person group的起点和总数。所有person group按照personGroupId的字母顺序存储。并且列表起始点被定义为personGroupId大于“start”的第一个person group。从这个起点开始，这个API返回第一个“top”person groups。 默认返回前1000个person groups，其中“start”的值为空，“top”的值为1,000。返回空数组表示没有personGroupId大于“start”的person group。例如，给定两个组：“first_group”和“second_group”，这两个组返回默认参数，如果指定“first_group”为“start”，则返回“second_group”;如果指定“second_group”为“start”返回空数组。 由当前呼叫返回的最后一个personGroupId可以用作下一次呼叫的“开始”以连续列出person groups。 Http Method `GET ` Request URL https://api.cognitive.azure.cn/face/v1.0/persongroups[?start][&top] Request parameters | 参数名|参数类型 |描述 | | --- | --- | --- | | start (可选) |string | 从最小的personGroupId列出大于“开始”的person groups。它包含不超过64个字符。默认是空的| | top (可选) |integer | 列出的person groups数量，范围[1，1000]。默认值是1000。| 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 成功的调用返回一组人员及其信息（personGroupId，name和userData）。 | 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" }, { "personGroupId":"sample_group2", "name":"group2", "userData":"User-provided data attached to the person group" } ] ~~~ Response 400 Error code and message returned in JSON | Error Code | Error Message Description | | --- | --- | | BadArgument | 有效范围是[1，1000]| ~~~ { "error":{ "statusCode": 400, "message": "Parameter top is invalid." } } ~~~ 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 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." } } ~~~