Share via

Jobs - ImportJobs Cancel

  • Odwołanie
Service:
Azure Digital Twins
API Version:
2023-10-31

Anuluje zadanie importu, które jest aktualnie uruchomione. Usługa zatrzyma wszystkie operacje importowania wyzwalane przez bieżące zadanie importowania, które są w toku, i przejdzie do stanu anulowania. Należy pamiętać, że spowoduje to pozostawienie wystąpienia w nieznanym stanie, ponieważ nie będzie żadnej operacji wycofywania. Kody stanu:

  • 200 Zaakceptowano żądanie
  • 400 Nieprawidłowe żądanie
    • ValidationFailed — żądanie zadania importu jest nieprawidłowe.
POST https://digitaltwins-hostname/jobs/imports/{id}/cancel?api-version=2023-10-31

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
id
 path True

string

Identyfikator zadania importu. Identyfikator jest unikatowy w usłudze i uwzględnia wielkość liter.
api-version
 query True

string

Żądana wersja interfejsu API.

Nagłówek żądania

Nazwa Wymagane Typ Opis
traceparent

string

Identyfikuje żądanie w rozproszonym systemie śledzenia.
tracestate

string

Dostarcza informacje identyfikacyjne śledzenia specyficzne dla dostawcy i jest towarzyszem śledzenia rodziców.

Odpowiedzi

Nazwa Typ Opis
200 OK

ImportJob

Powodzenie
Other Status Codes

ErrorResponse

Odpowiedź domyślna.

Headers

x-ms-error-code: string

Zabezpieczenia

oauth2

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

Przykłady

Cancel a job

Sample Request

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

Definicje

Nazwa Opis
Error

Definicja błędu.
ErrorResponse

Odpowiedź na błąd.
ImportJob

Zadanie zawierające odwołanie do operacji do wykonywania, wyników i metadanych wykonywania.
InnerError

Bardziej szczegółowy opis błędu niż został podany przez błąd zawierający.
status

Stan zadania.

Error

Definicja błędu.

Nazwa Typ Opis
code

string

Kod błędu specyficzny dla usługi, który służy jako stan podrzędny kodu błędu HTTP.
details

Error[]

Szczegóły błędu wewnętrznego.
innererror

InnerError

Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message

string

Czytelna dla człowieka reprezentacja błędu.

ErrorResponse

Odpowiedź na błąd.

Nazwa Typ Opis
error

Error

Szczegóły błędu.

ImportJob

Zadanie zawierające odwołanie do operacji do wykonywania, wyników i metadanych wykonywania.

Nazwa Typ Opis
createdDateTime

string

Godzina rozpoczęcia zadania. Znacznik czasu ma format RFC3339: yyyy-MM-ddTHH:mm:ssZ.
error

Error

Szczegóły błędów, które wystąpiły podczas wykonywania zadania importu.
finishedDateTime

string

Godzina zakończenia zadania. Znacznik czasu ma format RFC3339: yyyy-MM-ddTHH:mm:ssZ.
id

string

Identyfikator zadania importu.
inputBlobUri

string

Ścieżka do wejściowego obiektu blob usługi Azure Storage zawierającego pliki opisujące operacje do wykonania w zadaniu.
lastActionDateTime

string

Czas ostatniego wykonania dowolnej akcji z zadania. Znacznik czasu ma format RFC3339: yyyy-MM-ddTHH:mm:ssZ.
outputBlobUri

string

Ścieżka do wyjściowego obiektu blob usługi Azure Storage, który będzie zawierać błędy i dzienniki postępu zadania importu.
purgeDateTime

string

Czas, w którym zadanie zostanie przeczyszczone przez usługę z systemu. Znacznik czasu ma format RFC3339: yyyy-MM-ddTHH:mm:ssZ.
status

status

Stan zadania.

InnerError

Bardziej szczegółowy opis błędu niż został podany przez błąd zawierający.

Nazwa Typ Opis
code

string

Bardziej szczegółowy kod błędu niż został dostarczony przez błąd zawierający.
innererror

InnerError

Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.

status

Stan zadania.

Nazwa Typ Opis
cancelled

string

cancelling

string

failed

string

notstarted

string

running

string

succeeded

string