Snapshot - List

Référence

Service:: Azure AI Services

Version d'API:: 1.0-preview

Répertoriez tous les instantanés accessibles avec des informations connexes, y compris les instantanés qui ont été pris par l’utilisateur ou les instantanés à appliquer à l’utilisateur (l’ID d’abonnement a été inclus dans le applyScope dans Instantané - Prendre).

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
Endpoint	path	True	string	Points de terminaison Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : https://westus.api.cognitive.microsoft.com).
applyScope	query		string[]	L’utilisateur spécifié instantané appliquer des étendues en tant que filtre de recherche. ApplyScope est un tableau des ID d’abonnement Azure cibles pour le instantané, spécifiés par l’utilisateur qui a créé le instantané par capture instantanée - Prendre.
type	query		SnapshotObjectType	Type d’objet spécifié par l’utilisateur en tant que filtre de recherche.

En-tête de la demande

Nom	Obligatoire	Type	Description
Ocp-Apim-Subscription-Key	True	string

Réponses

Nom	Type	Description
200 OK	Snapshot[]	Un appel réussi retourne un tableau d’instantanés avec instantané informations.
Other Status Codes	APIError	Réponse d’erreur.

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
Dans: header

Exemples

List snapshots example

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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"
  }
]

Définitions

Nom	Description
APIError	Informations d’erreur retournées par l’API
Error	Corps de l’erreur.
Snapshot	Objet d’instantané. L’API Instantané déplace vos données en dehors de la zone géographique que vous sélectionnez pour votre ressource vers USA Ouest, Europe Ouest et Asie Sud-Est.
SnapshotObjectType	Type de l’objet source dans le instantané, spécifié par l’abonné qui a créé le instantané lors de l’appel de Capture instantanée - Take. Actuellement, FaceList, PersonGroup, LargeFaceList et LargePersonGroup sont pris en charge.

APIError

Informations d’erreur retournées par l’API

Nom	Type	Description
error	Error	Corps de l’erreur.

Error

Corps de l’erreur.

Nom	Type	Description
code	string
message	string

Snapshot

Objet d’instantané. L’API Instantané déplace vos données en dehors de la zone géographique que vous sélectionnez pour votre ressource vers USA Ouest, Europe Ouest et Asie Sud-Est.

Nom	Type	Description
account	string	Id de compte visage Azure Cognitive Service de l’abonné qui a créé le instantané par capture instantanée - Take.
applyScope	string[]	Tableau des ID d’abonnement Visage cible pour le instantané, spécifié par l’utilisateur qui a créé le instantané lors de l’appel de Capture instantanée - Take. Pour chaque instantané, seuls les abonnements inclus dans le applyScope of Snapshot - Take peuvent l’appliquer.
createdTime	string	Chaîne de date et d’heure UTC combinée qui décrit l’heure de création du instantané. Par exemple, 2018-12-25T11 :41 :02.2331413Z.
id	string	ID d’instantané.
lastUpdateTime	string	Chaîne de date et d’heure UTC combinée qui décrit la dernière fois où le instantané a été créé ou mis à jour par Capture instantanée - Mise à jour. Par exemple, 2018-12-25T11 :51 :27.8705696Z.
type	SnapshotObjectType	Type de l’objet source dans le instantané, spécifié par l’abonné qui a créé le instantané lors de l’appel de Capture instantanée - Take. Actuellement, FaceList, PersonGroup, LargeFaceList et LargePersonGroup sont pris en charge.
userData	string	L’utilisateur a spécifié des données sur le instantané à n’importe quelle fin. La longueur ne doit pas dépasser 16 Ko.

SnapshotObjectType

Type de l’objet source dans le instantané, spécifié par l’abonné qui a créé le instantané lors de l’appel de Capture instantanée - Take. Actuellement, FaceList, PersonGroup, LargeFaceList et LargePersonGroup sont pris en charge.

Nom	Type	Description
FaceList	string
LargeFaceList	string
LargePersonGroup	string
PersonGroup	string

Partager via