Snapshot - Get Operation Status
Obtenez status d’une opération de longue durée.
GET {Endpoint}/face/v1.0-preview/operations/{operationId}
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). |
operation
|
path | True |
string uuid |
ID référençant une opération take/apply particulière instantané. |
En-tête de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Un appel réussi retourne la status de l’opération. |
|
Other Status Codes |
Réponse d’erreur. |
Sécurité
Ocp-Apim-Subscription-Key
Type:
apiKey
Dans:
header
Exemples
Get snapshot operation status example
Exemple de requête
GET {Endpoint}/face/v1.0-preview/operations/a63a3bdd-a1db-4d05-87b8-dbad6850062a
Exemple de réponse
{
"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
}
Définitions
Nom | Description |
---|---|
APIError |
Informations d’erreur retournées par l’API |
Error |
Corps de l’erreur. |
Operation |
Opération status objet. L’opération fait référence à une tâche de back-end asynchrone. |
Operation |
Opération status : non démarré, en cours d’exécution, réussi, échec. Si l’opération est demandée et en attente d’exécution, le status n’est pas démarrer. Si l’opération est en cours dans le back-end, le status est en cours d’exécution. L’état réussi signifie que l’opération est terminée avec succès, en particulier pour instantané’opération de prise, il illustre l’instantané est bien pris et prêt à s’appliquer, et pour instantané’opération d’application, il présente que l’objet cible a terminé sa création par le instantané et prêt à être utilisé. L’échec de l’état est souvent dû à la modification de l’objet source lors de la prise de l’instantané ou à la modification de l’objet cible lors de l’application de la instantané avant l’achèvement. Consultez le champ « message » pour case activée la raison de l’échec. |
APIError
Informations d’erreur retournées par l’API
Nom | Type | Description |
---|---|---|
error |
Corps de l’erreur. |
Error
Corps de l’erreur.
Nom | Type | Description |
---|---|---|
code |
string |
|
message |
string |
OperationStatus
Opération status objet. L’opération fait référence à une tâche de back-end asynchrone.
Nom | Type | Description |
---|---|---|
createdTime |
string |
Chaîne de date et d’heure UTC combinée qui décrit l’heure à laquelle l’opération est demandée. Par exemple, 2018-12-25T11 :41 :02.2331413Z. |
finishedTime |
string |
Chaîne de date et d’heure UTC combinée qui décrit l’heure à laquelle l’opération s’est terminée. Par exemple, 2018-12-25T11 :41 :02.2331413Z. |
lastActionTime |
string |
Chaîne de date et d’heure UTC combinée qui décrit la dernière exécution active de l’opération. LastActionTime continue d’augmenter jusqu’à la fin de l’opération. Par exemple, 2018-12-25T11 :51 :27.8705696Z. |
message |
string |
Afficher le message d’échec en cas d’échec de l’opération (omis lorsque l’opération réussit). |
resourceLocation |
string |
Lorsque l’opération réussit correctement, pour instantané opération prenant l’opération, l’ID de instantané est inclus dans ce champ, et pour instantané’application de l’opération, le chemin d’obtention de l’objet cible est retourné dans ce champ. |
status |
Opération status : non démarré, en cours d’exécution, réussi, échec. Si l’opération est demandée et en attente d’exécution, le status n’est pas démarrer. Si l’opération est en cours dans le back-end, le status est en cours d’exécution. L’état réussi signifie que l’opération est terminée avec succès, en particulier pour instantané’opération de prise, il illustre l’instantané est bien pris et prêt à s’appliquer, et pour instantané’opération d’application, il présente que l’objet cible a terminé sa création par le instantané et prêt à être utilisé. L’échec de l’état est souvent dû à la modification de l’objet source lors de la prise de l’instantané ou à la modification de l’objet cible lors de l’application de la instantané avant l’achèvement. Consultez le champ « message » pour case activée la raison de l’échec. |
OperationStatusType
Opération status : non démarré, en cours d’exécution, réussi, échec. Si l’opération est demandée et en attente d’exécution, le status n’est pas démarrer. Si l’opération est en cours dans le back-end, le status est en cours d’exécution. L’état réussi signifie que l’opération est terminée avec succès, en particulier pour instantané’opération de prise, il illustre l’instantané est bien pris et prêt à s’appliquer, et pour instantané’opération d’application, il présente que l’objet cible a terminé sa création par le instantané et prêt à être utilisé. L’échec de l’état est souvent dû à la modification de l’objet source lors de la prise de l’instantané ou à la modification de l’objet cible lors de l’application de la instantané avant l’achèvement. Consultez le champ « message » pour case activée la raison de l’échec.
Nom | Type | Description |
---|---|---|
failed |
string |
|
notStarted |
string |
|
running |
string |
|
succeeded |
string |