Jobs - ImportJobs Cancel
Annule un travail d’importation en cours d’exécution. Le service arrête toutes les opérations d’importation déclenchées par le travail d’importation en cours et passe à un état annulé. Notez que cela laissera votre instance dans un état inconnu, car il n’y aura pas d’opération de restauration. Codes d’état :
- 200 demandes acceptées
- 400 Demande incorrecte
- ValidationFailed : la demande de travail d’importation n’est pas valide.
POST https://digitaltwins-hostname/jobs/imports/{id}/cancel?api-version=2023-10-31
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
id
|
path | True |
string |
ID du travail d’importation. L’ID est unique dans le service et respecte la casse. |
api-version
|
query | True |
string |
Version de l’API demandée. |
En-tête de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
traceparent |
string |
Identifie la demande dans un système de suivi distribué. |
|
tracestate |
string |
Fournit des informations d’identification de trace spécifiques au fournisseur et est un complément à traceparent. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Succès |
|
Other Status Codes |
Réponse par défaut. Headers x-ms-error-code: string |
Sécurité
oauth2
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize?resource=0b07f429-9f4b-4714-9392-cc5e8e80c8b0
Exemples
Cancel a job
Sample Request
POST https://digitaltwins-hostname/jobs/imports/importjob1/cancel?api-version=2023-10-31
Sample Response
{
"id": "importjob1",
"inputBlobUri": "path to input blob",
"outputBlobUri": "path to output blob",
"createdDateTime": "2022-01-01T00:00:00.0000000+00:00",
"lastActionDateTime": "2022-01-01T00:01:00.0000000+00:00",
"purgeDateTime": "2022-01-31T00:01:00.0000000+00:00",
"status": "cancelling"
}
Définitions
Nom | Description |
---|---|
Error |
Définition de l’erreur. |
Error |
Réponse d’erreur. |
Import |
Tâche qui contient une référence aux opérations à effectuer, aux résultats et aux métadonnées d’exécution. |
Inner |
Une description de l’erreur plus spécifique que celle fournie par l’erreur contenante. |
status |
État du travail. |
Error
Définition de l’erreur.
Nom | Type | Description |
---|---|---|
code |
string |
Code d’erreur spécifique au service qui sert de sous-état pour le code d’erreur HTTP. |
details |
Error[] |
Détails de l’erreur interne. |
innererror |
Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur. |
|
message |
string |
Représentation lisible par l’homme de l’erreur. |
ErrorResponse
Réponse d’erreur.
Nom | Type | Description |
---|---|---|
error |
Détails de l’erreur. |
ImportJob
Tâche qui contient une référence aux opérations à effectuer, aux résultats et aux métadonnées d’exécution.
Nom | Type | Description |
---|---|---|
createdDateTime |
string |
Heure de début du travail. L’horodatage est au format RFC3339 : |
error |
Détails des erreurs qui se sont produites lors de l’exécution du travail d’importation. |
|
finishedDateTime |
string |
Heure de fin du travail. L’horodatage est au format RFC3339 : |
id |
string |
Identificateur du travail d’importation. |
inputBlobUri |
string |
Chemin d’accès à l’objet blob de stockage Azure d’entrée qui contient le ou les fichiers décrivant les opérations à effectuer dans le travail. |
lastActionDateTime |
string |
La dernière fois que le service a effectué une action à partir du travail. L’horodatage est au format RFC3339 : |
outputBlobUri |
string |
Chemin d’accès à l’objet blob de stockage Azure de sortie qui contiendra les erreurs et les journaux de progression du travail d’importation. |
purgeDateTime |
string |
Heure à laquelle le travail sera purgé par le service du système. L’horodatage est au format RFC3339 : |
status |
État du travail. |
InnerError
Une description de l’erreur plus spécifique que celle fournie par l’erreur contenante.
Nom | Type | Description |
---|---|---|
code |
string |
Un code d’erreur plus spécifique que celui fourni par l’erreur contenante. |
innererror |
Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur. |
status
État du travail.
Nom | Type | Description |
---|---|---|
cancelled |
string |
|
cancelling |
string |
|
failed |
string |
|
notstarted |
string |
|
running |
string |
|
succeeded |
string |
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour