Jobs - ImportJobs Cancel

Service:

Azure Digital Twins

API Version:

2023-10-31

Bricht einen derzeit ausgeführten Importauftrag ab. Der Dienst beendet alle Importvorgänge, die durch den aktuellen Importauftrag ausgelöst werden, die gerade ausgeführt werden, und wechselt in einen abgebrochenen Zustand. Beachten Sie, dass Ihr instance dadurch in einem unbekannten Zustand bleibt, da es keinen Rollbackvorgang gibt. Statuscodes:

• 200 Anforderung akzeptiert
• 400 – Ungültige Anforderung
  • ValidationFailed: Die Importauftragsanforderung ist ungültig.

POST https://digitaltwins-hostname/jobs/imports/{id}/cancel?api-version=2023-10-31

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
id	path	True	string	Die ID für den Importauftrag. Die ID ist innerhalb des Diensts eindeutig und beachtet die Groß-/Kleinschreibung.
api-version	query	True	string	Die angeforderte API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
traceparent		string	Identifiziert die Anforderung in einem verteilten Ablaufverfolgungssystem.
tracestate		string	Stellt herstellerspezifische Ablaufverfolgungsinformationen bereit und ist ein Begleiter für traceparent.

Antworten

Name	Typ	Beschreibung
200 OK	ImportJob	Erfolg
Other Status Codes	ErrorResponse	Standardantwort. Headers x-ms-error-code: string

Sicherheit

oauth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=0b07f429-9f4b-4714-9392-cc5e8e80c8b0

Beispiele

Cancel a job

Sample Request

HTTP

POST https://digitaltwins-hostname/jobs/imports/importjob1/cancel?api-version=2023-10-31

Sample Response

Status code:

200

{
  "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"
}

Definitionen

Name	Beschreibung
Error	Fehlerdefinition.
ErrorResponse	Fehlerantwort.
ImportJob	Ein Auftrag, der einen Verweis auf die auszuführenden Vorgänge, Ergebnisse und Ausführungsmetadaten enthält.
InnerError	Eine spezifischere Fehlerbeschreibung als der enthaltende Fehler.
status	Status des Auftrags.

Error

Fehlerdefinition.

Name	Typ	Beschreibung
code	string	Dienstspezifischer Fehlercode, der als Unterstatus für den HTTP-Fehlercode dient.
details	Error[]	Interne Fehlerdetails.
innererror	InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine für Menschen lesbare Darstellung des Fehlers.

ErrorResponse

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Die Fehlerdetails.

ImportJob

Ein Auftrag, der einen Verweis auf die auszuführenden Vorgänge, Ergebnisse und Ausführungsmetadaten enthält.

Name	Typ	Beschreibung
createdDateTime	string	Startzeit des Auftrags. Der Zeitstempel hat RFC3339 Format: yyyy-MM-ddTHH:mm:ssZ.
error	Error	Details zu den Fehlern, die beim Ausführen des Importauftrags aufgetreten sind.
finishedDateTime	string	Endzeit des Auftrags. Der Zeitstempel hat RFC3339 Format: yyyy-MM-ddTHH:mm:ssZ.
id	string	Der Bezeichner des Importauftrags.
inputBlobUri	string	Der Pfad zum Azure Storage-Eingabeblob, das Dateien enthält, die die vorgänge beschreiben, die im Auftrag ausgeführt werden sollen.
lastActionDateTime	string	Zuletzt hat der Dienst eine Aktion aus dem Auftrag ausgeführt. Der Zeitstempel hat RFC3339 Format: yyyy-MM-ddTHH:mm:ssZ.
outputBlobUri	string	Der Pfad zum Azure Storage-Ausgabeblob, das die Fehler und Fortschrittsprotokolle des Importauftrags enthält.
purgeDateTime	string	Zeitpunkt, zu dem der Auftrag vom Dienst aus dem System gelöscht wird. Der Zeitstempel hat RFC3339 Format: yyyy-MM-ddTHH:mm:ssZ.
status	status	Status des Auftrags.

InnerError

Eine spezifischere Fehlerbeschreibung als der enthaltende Fehler.

Name	Typ	Beschreibung
code	string	Ein spezifischerer Fehlercode als vom enthaltenden Fehler bereitgestellt wurde.
innererror	InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.

status

Status des Auftrags.

Name	Typ	Beschreibung
cancelled	string
cancelling	string
failed	string
notstarted	string
running	string
succeeded	string