Snapshot - Get

リファレンス

サービス:: Azure AI Services

API バージョン:: 1.0

スナップショットに関する情報を取得します。スナップショットには、スナップショットを取得したソースサブスクリプションと、スナップショット - 取得で applyScope に含まれるターゲットサブスクリプションのみがアクセスできます。

GET {Endpoint}/face/v1.0/snapshots/{snapshotId}

URI パラメーター

名前	/	必須	型	説明
Endpoint	path	True	string	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名など)。 https://westus.api.cognitive.microsoft.com
snapshotId	path	True	string uuid	特定のスナップショットを参照する ID。

要求ヘッダー

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

応答

名前	型	説明
200 OK	Snapshot	呼び出しが成功すると、スナップショットの情報が返されます。
Other Status Codes	APIError	エラー応答。

セキュリティ

Ocp-Apim-Subscription-Key

型: apiKey
/: header

例

Get snapshot example

要求のサンプル

HTTP

GET {Endpoint}/face/v1.0/snapshots/e58b3f08-1e8b-4165-81df-aa9858f233dc

応答のサンプル

状態コード:: 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 snapshot.",
  "createdTime": "2018-12-25T11:41:02.2331413Z",
  "lastUpdateTime": "2018-12-25T11:51:27.8705696Z"
}

定義

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

APIError

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

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

Error

エラー本文。

名前	型	説明
code	string
message	string

Snapshot

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

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

SnapshotObjectType

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

名前	型	説明
FaceList	string
LargeFaceList	string
LargePersonGroup	string
PersonGroup	string

次の方法で共有