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

Snapshot - List

列出所有具有相关信息的可访问快照,包括用户创建的快照,或要应用于用户 (订阅 ID 的快照包含在 Snapshot - Take) 中的 applyScope 中。

GET {Endpoint}/face/v1.0/snapshots
GET {Endpoint}/face/v1.0/snapshots?type={type}&applyScope={applyScope}

URI 参数

Name In Required Type Description
Endpoint
path True
  • string

支持的认知服务终结点 (协议和主机名,例如: https://westus.api.cognitive.microsoft.com) 。

applyScope
query
  • array

用户指定的快照应用范围作为搜索筛选器。 ApplyScope 是快照的目标 Azure 订阅 ID 的数组,由创建快照的用户通过 Snapshot - Take 创建快照的用户指定。

type
query

用户将对象类型指定为搜索筛选器。

请求头

Name Required Type Description
Ocp-Apim-Subscription-Key True
  • string

响应

Name Type Description
200 OK

成功的调用返回包含快照信息的快照数组。

Other Status Codes

错误响应。

安全性

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

示例

List snapshots example

Sample Request

GET {Endpoint}/face/v1.0/snapshots?type=FaceList&applyScope=64084E07-9B7F-4A98-BEA4-9986D3A1EDEB

Sample Response

[
  {
    "id": "e58b3f08-1e8b-4165-81df-aa9858f233dc",
    "account": "/subscriptions/f9b96b36-1f5e-4021-8959-51527e26e6d3/resourceGroups/TestRG/providers/Microsoft.CognitiveServices/accounts/FaceTest01",
    "type": "FaceList",
    "applyScope": [
      "35230F59-AA9C-45E0-AB5E-C859BF1A5429",
      "64084E07-9B7F-4A98-BEA4-9986D3A1EDEB"
    ],
    "userData": "User-provided data attached to the snapshot1.",
    "createdTime": "2018-12-25T11:41:02.2331413Z",
    "lastUpdateTime": "2018-12-25T11:51:27.8705696Z"
  },
  {
    "id": "a61e61e4-c3d1-4d33-8ae8-676e6104757d",
    "account": "/subscriptions/6622996e-0149-4b22-9703-4216dc948d52/resourceGroups/TestRG/providers/Microsoft.CognitiveServices/accounts/FaceTest01",
    "type": "FaceList",
    "applyScope": [
      "64084E07-9B7F-4A98-BEA4-9986D3A1EDEB"
    ],
    "userData": "User-provided data attached to the snapshot2.",
    "createdTime": "2018-12-29T17:09:32.3298483Z",
    "lastUpdateTime": "2018-12-29T17:14:34.5645877Z"
  }
]

定义

APIError

API 返回的错误信息

Error

错误正文。

Snapshot

Snapshot 对象。 快照 API 会将为资源选择的地理区域外移动数据到美国西部、西欧和东南亚。

SnapshotObjectType

快照中的源对象的类型,由在调用 Snapshot - Take 时创建快照的订阅者指定。 目前支持 FaceList、PersonGroup、LargeFaceList 和 LargePersonGroup。

APIError

API 返回的错误信息

Name Type Description
error

错误正文。

Error

错误正文。

Name Type Description
code
  • string
message
  • string

Snapshot

Snapshot 对象。 快照 API 会将为资源选择的地理区域外移动数据到美国西部、西欧和东南亚。

Name Type Description
account
  • string

创建快照的订阅者的 Azure 认知服务人脸帐户 ID - 拍摄。

applyScope
  • string[]

快照的目标人脸订阅 ID 的数组,由在调用 Snapshot - Take 时创建快照的用户指定。 对于每个快照,只有 ApplyScope of Snapshot - Take 中包含的订阅才能应用它。

createdTime
  • string

描述快照创建时间的组合 UTC 日期和时间字符串。 例如 2018-12-25T11:41:02.2331413Z。

id
  • string

快照 ID。

lastUpdateTime
  • string

一个合并的 UTC 日期和时间字符串,用于描述快照创建或更新快照 - 更新的时间。 例如 2018-12-25T11:51:27.8705696Z。

type

快照中的源对象的类型,由在调用 Snapshot - Take 时创建快照的订阅者指定。 目前支持 FaceList、PersonGroup、LargeFaceList 和 LargePersonGroup。

userData
  • string

用户针对任何目的指定了有关快照的数据。 长度不应超过 16KB。

SnapshotObjectType

快照中的源对象的类型,由在调用 Snapshot - Take 时创建快照的订阅者指定。 目前支持 FaceList、PersonGroup、LargeFaceList 和 LargePersonGroup。

Name Type Description
FaceList
  • string
LargeFaceList
  • string
LargePersonGroup
  • string
PersonGroup
  • string