Snapshot - List

Referencia

Servicio:: Azure AI Services

Versión de la API:: 1.0-preview

Enumere todas las instantáneas accesibles con información relacionada, incluidas las instantáneas realizadas por el usuario, o las instantáneas que se aplicarán al usuario (el identificador de suscripción se incluyó en applyScope en Snapshot - Take).

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string	Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://westus.api.cognitive.microsoft.com).
applyScope	query		string[]	La instantánea especificada por el usuario aplica ámbitos como filtro de búsqueda. ApplyScope es una matriz de los identificadores de suscripción de Azure de destino para la instantánea, especificada por el usuario que creó la instantánea mediante Snapshot - Take.
type	query		SnapshotObjectType	Tipo de objeto especificado por el usuario como filtro de búsqueda.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Respuestas

Nombre	Tipo	Description
200 OK	Snapshot[]	Una llamada correcta devuelve una matriz de instantáneas con información de instantáneas.
Other Status Codes	APIError	Respuesta de error.

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

Ejemplos

List snapshots example

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

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

Definiciones

Nombre	Description
APIError	Información de error devuelta por la API
Error	Cuerpo del error.
Snapshot	Objeto snapshot. La API de instantáneas moverá los datos fuera de la ubicación geográfica que seleccione para el recurso a Oeste de EE. UU., Oeste de Europa y Sudeste de Asia.
SnapshotObjectType	Tipo del objeto de origen en la instantánea, especificado por el suscriptor que creó la instantánea al llamar a Snapshot - Take. Actualmente se admiten FaceList, PersonGroup, LargeFaceList y LargePersonGroup.

APIError

Información de error devuelta por la API

Nombre	Tipo	Description
error	Error	Cuerpo del error.

Error

Cuerpo del error.

Nombre	Tipo	Description
code	string
message	string

Snapshot

Objeto snapshot. La API de instantáneas moverá los datos fuera de la ubicación geográfica que seleccione para el recurso a Oeste de EE. UU., Oeste de Europa y Sudeste de Asia.

Nombre	Tipo	Description
account	string	Identificador de cuenta de Face de Azure Cognitive Service del suscriptor que creó la instantánea mediante Snapshot - Take.
applyScope	string[]	Matriz de los identificadores de suscripción de Face de destino para la instantánea, especificada por el usuario que creó la instantánea al llamar a Snapshot - Take. Para cada instantánea, solo las suscripciones incluidas en applyScope of Snapshot - Take pueden aplicarla.
createdTime	string	Cadena de fecha y hora UTC combinada que describe la hora creada de la instantánea. Por ejemplo, 2018-12-25T11:41:02.2331413Z.
id	string	Id. de instantánea.
lastUpdateTime	string	Cadena de fecha y hora UTC combinada que describe la última vez que la instantánea se creó o actualizó mediante Snapshot - Update. Por ejemplo, 2018-12-25T11:51:27.8705696Z.
type	SnapshotObjectType	Tipo del objeto de origen en la instantánea, especificado por el suscriptor que creó la instantánea al llamar a Snapshot - Take. Actualmente se admiten FaceList, PersonGroup, LargeFaceList y LargePersonGroup.
userData	string	Los datos especificados por el usuario sobre la instantánea para cualquier propósito. La longitud no debe superar los 16 KB.

SnapshotObjectType

Tipo del objeto de origen en la instantánea, especificado por el suscriptor que creó la instantánea al llamar a Snapshot - Take. Actualmente se admiten FaceList, PersonGroup, LargeFaceList y LargePersonGroup.

Nombre	Tipo	Description
FaceList	string
LargeFaceList	string
LargePersonGroup	string
PersonGroup	string

Compartir a través de