Snapshot - List

參考

服務:: Azure AI Services

API 版本:: 1.0-preview

列出所有具有相關信息的可存取快照集，包括使用者所擷取的快照集，或要套用至使用者 (訂用帳戶標識碼的快照集包含在 Snapshot - Take) 的 applyScope 中。

GET {Endpoint}/face/v1.0-preview/snapshots

含選擇性參數:

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

URI 參數

名稱	位於	必要	類型	Description
Endpoint	path	True	string	支援的認知服務端點 (通訊協定和主機名，例如： https://westus.api.cognitive.microsoft.com) 。
applyScope	query		string[]	使用者指定的快照集會將範圍套用為搜尋篩選條件。 ApplyScope 是快照集的目標 Azure 訂用帳戶標識碼陣列，由依快照集 - 擷取建立快照集的使用者所指定。
type	query		SnapshotObjectType	使用者指定的物件類型做為搜尋篩選。

要求標頭

名稱	必要	類型	Description
Ocp-Apim-Subscription-Key	True	string

回應

名稱	類型	Description
200 OK	Snapshot[]	成功的呼叫會傳回快照集的陣列，其中包含快照集資訊。
Other Status Codes	APIError	錯誤回應。

安全性

Ocp-Apim-Subscription-Key

類型: apiKey
位於: header

範例

List snapshots example

範例要求

HTTP

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

範例回覆

狀態碼:: 200

[
  {
    "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"
  }
]

定義

名稱	Description
APIError	API 傳回的錯誤資訊
Error	錯誤本文。
Snapshot	Snapshot 物件。快照集 API 會將您為資源選取的地理位置外移動您的數據，並將其移至美國西部、西歐和東南亞。
SnapshotObjectType	快照集中來源對象的類型，由呼叫 Snapshot - Take 時建立快照集的訂閱者所指定。目前支援FaceList、PersonGroup、LargeFaceList和 LargePersonGroup。

APIError

API 傳回的錯誤資訊

名稱	類型	Description
error	Error	錯誤本文。

Error

錯誤本文。

名稱	類型	Description
code	string
message	string

Snapshot

Snapshot 物件。快照集 API 會將您為資源選取的地理位置外移動您的數據，並將其移至美國西部、西歐和東南亞。

名稱	類型	Description
account	string	依快照集建立快照集之訂閱者的 Azure 認知服務臉部帳戶標識碼 - 擷取。
applyScope	string[]	快照集的目標臉部訂用帳戶標識碼陣列，由呼叫快照集 - 擷取時建立快照集的使用者所指定。針對每個快照集，只有包含於 Snapshot 的 applyScope - Take 中的訂用帳戶可以套用它。
createdTime	string	描述快照集建立時間的合併UTC日期和時間字串。例如 2018-12-25T11：41：02.2331413Z。
id	string	快照集標識碼。
lastUpdateTime	string	結合的 UTC 日期和時間字串，描述快照集建立或更新快照集 - 更新的上次時間。例如 2018-12-25T11：51：27.8705696Z。
type	SnapshotObjectType	快照集中來源對象的類型，由呼叫 Snapshot - Take 時建立快照集的訂閱者所指定。目前支援FaceList、PersonGroup、LargeFaceList和 LargePersonGroup。
userData	string	用戶針對任何用途指定快照集的相關數據。長度不應超過 16KB。

SnapshotObjectType

快照集中來源對象的類型，由呼叫 Snapshot - Take 時建立快照集的訂閱者所指定。目前支援FaceList、PersonGroup、LargeFaceList和 LargePersonGroup。

名稱	類型	Description
FaceList	string
LargeFaceList	string
LargePersonGroup	string
PersonGroup	string

共用方式為