Snapshot - List

Odwołanie

Usługa:: Azure AI Services

Wersja interfejsu API:: 1.0-preview

Wyświetl listę wszystkich dostępnych migawek z powiązanymi informacjami, w tym migawkami wykonanymi przez użytkownika lub migawkami, które mają zostać zastosowane do użytkownika (identyfikator subskrypcji został uwzględniony w aplikacji applyScope in Snapshot - Take).

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://westus.api.cognitive.microsoft.com).
applyScope	query		string[]	Migawka określona przez użytkownika stosuje zakresy jako filtr wyszukiwania. ApplyScope to tablica docelowych identyfikatorów subskrypcji platformy Azure dla migawki określonej przez użytkownika, który utworzył migawkę za pomocą migawki — wykonaj.
type	query		SnapshotObjectType	Typ obiektu określony przez użytkownika jako filtr wyszukiwania.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Snapshot[]	Pomyślne wywołanie zwraca tablicę migawek z informacjami o migawkach.
Other Status Codes	APIError	Odpowiedź na błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

Przykłady

List snapshots example

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

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

Definicje

Nazwa	Opis
APIError	Informacje o błędzie zwrócone przez interfejs API
Error	Treść błędu.
Snapshot	Obiekt migawki. Interfejs API migawek przeniesie dane poza obszar geograficzny wybrany dla zasobu do regionów Zachodnie stany USA, Europa Zachodnia i Azja Południowo-Wschodnia.
SnapshotObjectType	Typ obiektu źródłowego w migawce określony przez subskrybenta, który utworzył migawkę podczas wywoływania migawki — Wykonaj. Obecnie obsługiwane są funkcje FaceList, PersonGroup, LargeFaceList i LargePersonGroup.

APIError

Informacje o błędzie zwrócone przez interfejs API

Nazwa	Typ	Opis
error	Error	Treść błędu.

Error

Treść błędu.

Nazwa	Typ	Opis
code	string
message	string

Snapshot

Obiekt migawki. Interfejs API migawek przeniesie dane poza obszar geograficzny wybrany dla zasobu do regionów Zachodnie stany USA, Europa Zachodnia i Azja Południowo-Wschodnia.

Nazwa	Typ	Opis
account	string	Identyfikator konta rozpoznawania twarzy usługi Azure Cognitive Service subskrybenta, który utworzył migawkę za pomocą migawki — wykonaj.
applyScope	string[]	Tablica docelowych identyfikatorów subskrypcji rozpoznawania twarzy dla migawki określona przez użytkownika, który utworzył migawkę podczas wywoływania migawki — wykonaj. Dla każdej migawki można zastosować tylko subskrypcje uwzględnione w stoszakresie migawek .
createdTime	string	Połączony ciąg daty i godziny UTC, który opisuje czas utworzenia migawki. Np. 2018-12-25T11:41:02.2331413Z.
id	string	Identyfikator migawki.
lastUpdateTime	string	Połączony ciąg daty i godziny UTC, który opisuje czas ostatniej utworzenia lub zaktualizowania migawki przez migawkę — aktualizacja. Np. 2018-12-25T11:51:27.8705696Z.
type	SnapshotObjectType	Typ obiektu źródłowego w migawce określony przez subskrybenta, który utworzył migawkę podczas wywoływania migawki — Wykonaj. Obecnie obsługiwane są funkcje FaceList, PersonGroup, LargeFaceList i LargePersonGroup.
userData	string	Użytkownik określił dane dotyczące migawki w dowolnym celu. Długość nie powinna przekraczać 16 KB.

SnapshotObjectType

Typ obiektu źródłowego w migawce określony przez subskrybenta, który utworzył migawkę podczas wywoływania migawki — Wykonaj. Obecnie obsługiwane są funkcje FaceList, PersonGroup, LargeFaceList i LargePersonGroup.

Nazwa	Typ	Opis
FaceList	string
LargeFaceList	string
LargePersonGroup	string
PersonGroup	string

Udostępnij za pośrednictwem