你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Person Directory Operations - Get Dynamic Person Groups

服务:

Azure AI Services

API 版本:

v1.2-preview.1

通过 dynamicPersonGroupId 以及名称和 userData 列出所有现有的动态人员组。
动态人员组按字母顺序存储 dynamicPersonGroupId。

• • “start”参数（字符串，可选）指定一个 ID 值，从中返回的条目将根据字符串比较具有更大的 ID。 将“start”设置为空值表示应从第一项开始返回条目。
  • “top”参数（int，可选）确定要返回的最大条目数，每个调用的最大条目数限制为 1000 个。 若要检索超出此限制的其他条目，请使用当前调用中返回的最后一项的 personId 指定“start”。

提示

• 例如，共有 5 个项目及其 ID：“itemId1”、...、“itemId5”。
  • “start=&top=”将返回所有 5 个项目。
  • “start=&top=2”将返回“itemId1”、“itemId2”。
  • “start=itemId2&top=3”将返回“itemId3”、“itemId4”、“itemId5”。

GET {endpoint}/face/{apiVersion}/dynamicpersongroups

具有可选参数:

GET {endpoint}/face/{apiVersion}/dynamicpersongroups?start={start}&top={top}

URI 参数

名称	在	必需	类型	说明
apiVersion	path	True	string	API 版本
endpoint	path	True	string uri	支持的认知服务终结点（协议和主机名，例如：https://{resource-name}.cognitiveservices.azure.com）。
start	query		string	列出大于“start”的资源。 它包含不超过 64 个字符。 默认值为空。
top	query		integer int32	要列出的项目数，范围为 [1， 1000]。 默认值为 1000。

响应

名称	类型	说明
200 OK	DynamicPersonGroup[]	成功的调用返回动态人员组及其信息数组（dynamicPersonGroupId、名称和 userData）。
Other Status Codes	FaceErrorResponse	意外的错误响应。 标头 x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

Azure AI 人脸订阅的密钥。

类型: apiKey
在: header

AADToken

Azure Active Directory OAuth2 流

类型: oauth2
流向: accessCode
授权 URL: https://api.example.com/oauth2/authorize
令牌 URL: https://api.example.com/oauth2/token

作用域

名称	说明
https://cognitiveservices.azure.com/.default

示例

Get DynamicPersonGroups

示例请求

HTTP

GET {endpoint}/face/v1.2-preview.1/dynamicpersongroups?start=dynamic_person_group_id&top=20

示例响应

状态代码:

200

[
  {
    "dynamicPersonGroupId": "your_dynamic_person_group_id",
    "name": "your_dynamic_person_group_name",
    "userData": "your_user_data"
  }
]

定义

名称	说明
DynamicPersonGroup	引用 Person 目录“创建人员”的容器。
FaceError	错误对象。 有关人脸服务返回的错误代码和消息的综合详细信息，请参阅以下链接：https://aka.ms/face-error-codes-and-messages。
FaceErrorResponse	包含错误详细信息的响应。

DynamicPersonGroup

引用 Person 目录“创建人员”的容器。

名称	类型	说明
dynamicPersonGroupId	string	动态人员组的 ID。
name	string	用户定义的名称，最大长度为 128。
userData	string	可选用户定义数据。 长度不应超过 16K。

FaceError

错误对象。 有关人脸服务返回的错误代码和消息的综合详细信息，请参阅以下链接：https://aka.ms/face-error-codes-and-messages。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
message	string	错误的人工可读表示形式。

FaceErrorResponse

包含错误详细信息的响应。

名称	类型	说明
error	FaceError	错误对象。