Share via


Jobs - ImportJobs Cancel

Avbryter ett importjobb som körs. Tjänsten stoppar alla importåtgärder som utlöses av det aktuella importjobbet som pågår och går till ett avbrutet tillstånd. Observera att detta lämnar instansen i ett okänt tillstånd eftersom det inte blir någon återställningsåtgärd. Statuskoder:

  • 200 Begäran accepterad
  • 400 Felaktig begäran
    • ValidationFailed – importjobbets begäran är inte giltig.
POST https://digitaltwins-hostname/jobs/imports/{id}/cancel?api-version=2023-10-31

URI-parametrar

Name I Obligatorisk Typ Description
id
path True

string

ID:t för importjobbet. ID:t är unikt inom tjänsten och skiftlägeskänsligt.

api-version
query True

string

Den begärda API-versionen.

Begärandehuvud

Name Obligatorisk Typ Description
traceparent

string

Identifierar begäran i ett distribuerat spårningssystem.

tracestate

string

Tillhandahåller leverantörsspecifik spårningsidentifieringsinformation och är ett komplement till traceparent.

Svar

Name Typ Description
200 OK

ImportJob

Klart

Other Status Codes

ErrorResponse

Standardsvar.

Headers

x-ms-error-code: string

Säkerhet

oauth2

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

Exempel

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

Definitioner

Name Description
Error

Feldefinition.

ErrorResponse

Felsvar.

ImportJob

Ett jobb som innehåller en referens till de åtgärder som ska utföras, resultat och körningsmetadata.

InnerError

En mer specifik felbeskrivning än vad som angavs av det innehållande felet.

status

Jobbets status.

Error

Feldefinition.

Name Typ Description
code

string

Tjänstspecifik felkod som fungerar som understatus för HTTP-felkoden.

details

Error[]

Intern felinformation.

innererror

InnerError

Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.

message

string

En mänsklig läsbar representation av felet.

ErrorResponse

Felsvar.

Name Typ Description
error

Error

Felinformationen.

ImportJob

Ett jobb som innehåller en referens till de åtgärder som ska utföras, resultat och körningsmetadata.

Name Typ Description
createdDateTime

string

Jobbets starttid. Tidsstämpeln är i RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.

error

Error

Information om de fel som uppstod när importjobbet kördes.

finishedDateTime

string

Jobbets sluttid. Tidsstämpeln är i RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.

id

string

Identifieraren för importjobbet.

inputBlobUri

string

Sökvägen till den Azure Storage-blob som innehåller filer som beskriver de åtgärder som ska utföras i jobbet.

lastActionDateTime

string

Senaste gången tjänsten utförde en åtgärd från jobbet. Tidsstämpeln är i RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.

outputBlobUri

string

Sökvägen till utdata för Azure Storage-bloben som innehåller felen och förloppsloggarna för importjobbet.

purgeDateTime

string

Tid då jobbet rensas av tjänsten från systemet. Tidsstämpeln är i RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.

status

status

Jobbets status.

InnerError

En mer specifik felbeskrivning än vad som angavs av det innehållande felet.

Name Typ Description
code

string

En mer specifik felkod än vad som angavs av det innehållande felet.

innererror

InnerError

Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.

status

Jobbets status.

Name Typ Description
cancelled

string

cancelling

string

failed

string

notstarted

string

running

string

succeeded

string