Snapshot - List

Referenz

Dienst:: Azure AI Services

API-Version:: 1.0

Listen Sie alle zugänglichen Momentaufnahmen mit zugehörigen Informationen auf, einschließlich momentaufnahmen, die vom Benutzer erstellt wurden, oder Momentaufnahmen, die auf den Benutzer angewendet werden sollen (die Abonnement-ID war in applyScope in Snapshot – Take enthalten).

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
Endpoint	path	True	string	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. ). https://westus.api.cognitive.microsoft.com
applyScope	query		string[]	Vom Benutzer angegeben Momentaufnahme Bereiche als Suchfilter anwenden. ApplyScope ist ein Array der Azure-Zielabonnement-IDs für die Momentaufnahme, die vom Benutzer angegeben wird, der die Momentaufnahme erstellt hat, durch Snapshot – Take.
type	query		SnapshotObjectType	Vom Benutzer angegebene Objekttyp als Suchfilter.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string

Antworten

Name	Typ	Beschreibung
200 OK	Snapshot[]	Ein erfolgreicher Aufruf gibt ein Array von Momentaufnahmen mit Momentaufnahme Informationen zurück.
Other Status Codes	APIError	Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

Beispiele

List snapshots example

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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"
  }
]

Definitionen

Name	Beschreibung
APIError	Von der API zurückgegebene Fehlerinformationen
Error	Fehlertext.
Snapshot	Momentaufnahmeobjekt. Die Momentaufnahme-API verschenkt Ihre Daten außerhalb des geografischen Raums, den Sie für Ihre Ressource ausgewählt haben, nach USA, Westen, Europa, Westen und Asien, Südosten.
SnapshotObjectType	Typ des Quellobjekts im Momentaufnahme, der vom Abonnenten angegeben wird, der die Momentaufnahme erstellt hat, wenn Snapshot – Take aufgerufen wird. Derzeit werden FaceList, PersonGroup, LargeFaceList und LargePersonGroup unterstützt.

APIError

Von der API zurückgegebene Fehlerinformationen

Name	Typ	Beschreibung
error	Error	Fehlertext.

Error

Fehlertext.

Name	Typ	Beschreibung
code	string
message	string

Snapshot

Momentaufnahmeobjekt. Die Momentaufnahme-API verschenkt Ihre Daten außerhalb des geografischen Raums, den Sie für Ihre Ressource ausgewählt haben, nach USA, Westen, Europa, Westen und Asien, Südosten.

Name	Typ	Beschreibung
account	string	Die Azure Cognitive Service-Gesichtserkennungs-Konto-ID des Abonnenten, der die Momentaufnahme by Snapshot – Take erstellt hat.
applyScope	string[]	Array der Ziel-Gesichtserkennungsabonnement-IDs für die Momentaufnahme, die vom Benutzer, der die Momentaufnahme erstellt hat, beim Aufruf von Snapshot – Take angegeben wurde. Für jede Momentaufnahme können nur Abonnements angewendet werden, die im applyScope of Snapshot – Take enthalten sind.
createdTime	string	Eine kombinierte UTC-Datums- und Uhrzeitzeichenfolge, die die Erstellungszeit des Momentaufnahme beschreibt. Beispiel: 2018-12-25T11:41:02.2331413Z.
id	string	Momentaufnahme-ID.
lastUpdateTime	string	Eine kombinierte UTC-Datums- und Uhrzeitzeichenfolge, die den zeitpunkt beschreibt, zu dem der Momentaufnahme von Snapshot – Update erstellt oder aktualisiert wurde. Beispiel: 2018-12-25T11:51:27.8705696Z.
type	SnapshotObjectType	Typ des Quellobjekts im Momentaufnahme, der vom Abonnenten angegeben wird, der die Momentaufnahme erstellt hat, wenn Snapshot – Take aufgerufen wird. Derzeit werden FaceList, PersonGroup, LargeFaceList und LargePersonGroup unterstützt.
userData	string	Vom Benutzer angegebene Daten über die Momentaufnahme für jeden Zweck. Die Länge sollte 16 KB nicht überschreiten.

SnapshotObjectType

Typ des Quellobjekts im Momentaufnahme, der vom Abonnenten angegeben wird, der die Momentaufnahme erstellt hat, wenn Snapshot – Take aufgerufen wird. Derzeit werden FaceList, PersonGroup, LargeFaceList und LargePersonGroup unterstützt.

Name	Typ	Beschreibung
FaceList	string
LargeFaceList	string
LargePersonGroup	string
PersonGroup	string

Freigeben über