Snapshot - List

サービス:

Azure AI Services

API バージョン:

1.0-preview

ユーザーが取得したスナップショットやユーザーに適用するスナップショットなど、関連情報を含むすべてのアクセス可能なスナップショットを一覧表示します (サブスクリプション ID は Snapshot - Take の applyScope に含まれていました)。

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

省略可能なパラメーターを含む:

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

URI パラメーター

名前	/	必須	型	説明
Endpoint	path	True	string	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名、例: https://westus.api.cognitive.microsoft.com)。
applyScope	query		string[]	ユーザー指定のスナップショットは、検索フィルターとしてスコープを適用します。 ApplyScope は、スナップショットのターゲット Azure サブスクリプション ID の配列で、スナップショットを作成したユーザーによってスナップショットを作成したユーザーによって指定されます。
type	query		SnapshotObjectType	ユーザーが検索フィルターとして指定したオブジェクトの種類。

要求ヘッダー

名前	必須	型	説明
Ocp-Apim-Subscription-Key	True	string

応答

名前	型	説明
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"
  }
]

定義

名前	説明
APIError	API によって返されるエラー情報
Error	エラー本文。
Snapshot	スナップショット オブジェクト。 Snapshot API は、リソースに対して選択した geo の外部のデータを米国西部、西ヨーロッパ、東南アジアに移動します。
SnapshotObjectType	スナップショットの呼び出し時にスナップショットを作成したサブスクライバーによって指定された、スナップショット内のソース オブジェクトの種類 - Take。 現在、FaceList、PersonGroup、LargeFaceList、および LargePersonGroup がサポートされています。

APIError

Object

API によって返されるエラー情報

名前	型	説明
error	Error	エラー本文。

Error

Object

エラー本文。

名前	型	説明
code	string
message	string

Snapshot

Object

スナップショット オブジェクト。 Snapshot API は、リソースに対して選択した geo の外部のデータを米国西部、西ヨーロッパ、東南アジアに移動します。

名前	型	説明
account	string	スナップショットによってスナップショットを作成したサブスクライバーの Azure Cognitive Service Face アカウント ID - Take。
applyScope	string[] (uuid)	スナップショットの呼び出し時にスナップショットを作成したユーザーによって指定された、スナップショットのターゲット Face サブスクリプション ID の配列 - Take。 スナップショットごとに、applyScope of Snapshot - Take に含まれるサブスクリプションのみを適用できます。
createdTime	string (date-time)	スナップショットの作成時刻を表す UTC 日付と時刻の組み合わせ文字列。 例: 2018-12-25T11:41:02.2331413Z。
id	string (uuid)	スナップショット ID。
lastUpdateTime	string (date-time)	スナップショットの作成または更新によってスナップショットが最後に作成または更新された時刻を表す UTC 日付と時刻の組み合わせ文字列 。 例: 2018-12-25T11:51:27.8705696Z。
type	SnapshotObjectType	スナップショットの呼び出し時にスナップショットを作成したサブスクライバーによって指定された、スナップショット内のソース オブジェクトの種類 - Take。 現在、FaceList、PersonGroup、LargeFaceList、および LargePersonGroup がサポートされています。
userData	string maxLength: 16384	ユーザーが任意の目的でスナップショットに関するデータを指定しました。 長さは 16 KB を超えないようにしてください。

SnapshotObjectType

列挙

スナップショットの呼び出し時にスナップショットを作成したサブスクライバーによって指定された、スナップショット内のソース オブジェクトの種類 - Take。 現在、FaceList、PersonGroup、LargeFaceList、および LargePersonGroup がサポートされています。

値	説明
FaceList
LargeFaceList
LargePersonGroup
PersonGroup