Snapshot - Get Operation Status

Tjänst:

Azure AI Services

API-version:

1.0-preview

Hämta status för en tidskrävande åtgärd.

GET {Endpoint}/face/v1.0-preview/operations/{operationId}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
Endpoint	path	True	string	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://westus.api.cognitive.microsoft.com).
operationId	path	True	string (uuid)	ID som refererar till en viss åtgärd för att ta/tillämpa ögonblicksbilder.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Svar

Name	Typ	Description
200 OK	OperationStatus	Ett lyckat anrop returnerar åtgärdens status.
Other Status Codes	APIError	Felsvar.

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

Exempel

Get snapshot operation status example

Exempelbegäran

HTTP

GET {Endpoint}/face/v1.0-preview/operations/a63a3bdd-a1db-4d05-87b8-dbad6850062a

Exempelsvar

Statuskod:

200

{
  "status": "succeeded",
  "createdTime": "2018-12-25T11:41:02.2331413Z",
  "lastActionTime": "2018-12-25T11:51:27.8705696Z",
  "resourceLocation": "/snapshots/e58b3f08-1e8b-4165-81df-aa9858f233dc",
  "message": null
}

Definitioner

Name	Description
APIError	Felinformation som returneras av API:et
Error	Feltext.
OperationStatus	Åtgärdsstatusobjekt. Åtgärden refererar till en asynkron serverdelsaktivitet.
OperationStatusType	Åtgärdsstatus: notstarted, running, succeeded, failed. Om åtgärden begärs och väntar på att utföras startas inte statusen. Om åtgärden pågår i serverdelen körs statusen. Statusen lyckades innebär att åtgärden har slutförts, särskilt för att ta ögonblicksbilder, det illustrerar att ögonblicksbilden är väl tagen och redo att tillämpas, och för åtgärd för användning av ögonblicksbilder visar den att målobjektet har skapats av ögonblicksbilden och är redo att användas. Statusen misslyckades orsakas ofta av att källobjektet redigeras när ögonblicksbilden tas eller att målobjektet redigeras när ögonblicksbilden tillämpas före slutförandet. Se fältet "meddelande" för att kontrollera orsaken till felet.

APIError

Objekt

Felinformation som returneras av API:et

Name	Typ	Description
error	Error	Feltext.

Error

Objekt

Feltext.

Name	Typ	Description
code	string
message	string

OperationStatus

Objekt

Åtgärdsstatusobjekt. Åtgärden refererar till en asynkron serverdelsaktivitet.

Name	Typ	Description
createdTime	string (date-time)	En kombinerad UTC-datum- och tidssträng som beskriver den tid då åtgärden begärs. T.ex. 2018-12-25T11:41:02.2331413Z.
finishedTime	string (date-time)	En kombinerad UTC-datum- och tidssträng som beskriver tiden då åtgärden slutfördes. T.ex. 2018-12-25T11:41:02.2331413Z.
lastActionTime	string (date-time)	En kombinerad UTC-datum- och tidssträng som beskriver den senaste gången åtgärden körs aktivt. LastActionTime fortsätter att öka tills åtgärden har slutförts. T.ex. 2018-12-25T11:51:27.8705696Z.
message	string	Visa felmeddelande när åtgärden misslyckas (utelämnas när åtgärden lyckas).
resourceLocation	string	När åtgärden lyckas inkluderas ögonblicksbilds-ID:t i det här fältet för ögonblicksbildsåtgärden, och för åtgärd för användning av ögonblicksbilder returneras sökvägen för att hämta målobjektet i det här fältet.
status	OperationStatusType	Åtgärdsstatus: notstarted, running, succeeded, failed. Om åtgärden begärs och väntar på att utföras startas inte statusen. Om åtgärden pågår i serverdelen körs statusen. Statusen lyckades innebär att åtgärden har slutförts, särskilt för att ta ögonblicksbilder, det illustrerar att ögonblicksbilden är väl tagen och redo att tillämpas, och för åtgärd för användning av ögonblicksbilder visar den att målobjektet har skapats av ögonblicksbilden och är redo att användas. Statusen misslyckades orsakas ofta av att källobjektet redigeras när ögonblicksbilden tas eller att målobjektet redigeras när ögonblicksbilden tillämpas före slutförandet. Se fältet "meddelande" för att kontrollera orsaken till felet.

OperationStatusType

Uppräkning

Åtgärdsstatus: notstarted, running, succeeded, failed. Om åtgärden begärs och väntar på att utföras startas inte statusen. Om åtgärden pågår i serverdelen körs statusen. Statusen lyckades innebär att åtgärden har slutförts, särskilt för att ta ögonblicksbilder, det illustrerar att ögonblicksbilden är väl tagen och redo att tillämpas, och för åtgärd för användning av ögonblicksbilder visar den att målobjektet har skapats av ögonblicksbilden och är redo att användas. Statusen misslyckades orsakas ofta av att källobjektet redigeras när ögonblicksbilden tas eller att målobjektet redigeras när ögonblicksbilden tillämpas före slutförandet. Se fältet "meddelande" för att kontrollera orsaken till felet.

Värde	Description
failed
notStarted
running
succeeded