Jobs - ImportJobs Cancel

Service:

Azure Digital Twins

API Version:

2023-10-31

Hiermee annuleert u een importtaak die momenteel wordt uitgevoerd. De service stopt alle importbewerkingen die worden geactiveerd door de huidige importtaak die wordt uitgevoerd en gaat naar de status Geannuleerd. Houd er rekening mee dat uw exemplaar hierdoor een onbekende status heeft, omdat er geen terugdraaibewerking wordt uitgevoerd. Statuscodes:

• 200 Aanvraag geaccepteerd
• 400 Ongeldige aanvraag
  • ValidationFailed : de aanvraag voor de importtaak is ongeldig.

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

URI-parameters

Name	In	Vereist	Type	Description
id	path	True	string	De id voor de importtaak. De id is uniek binnen de service en hoofdlettergevoelig.
api-version	query	True	string	De aangevraagde API-versie.

Aanvraagkoptekst

Name	Vereist	Type	Description
traceparent		string	Identificeert de aanvraag in een gedistribueerd traceringssysteem.
tracestate		string	Biedt leverancierspecifieke traceringsidentificatie-informatie en is een aanvulling op traceringsouder.

Antwoorden

Name	Type	Description
200 OK	ImportJob	Geslaagd
Other Status Codes	ErrorResponse	Standaardantwoord. Headers x-ms-error-code: string

Beveiliging

oauth2

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

Voorbeelden

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

Definities

Name	Description
Error	Foutdefinitie.
ErrorResponse	Foutreactie.
ImportJob	Een taak die een verwijzing bevat naar de uit te voeren bewerkingen, resultaten en metagegevens van de uitvoering.
InnerError	Een specifiekere foutbeschrijving dan is opgegeven door de betreffende fout.
status	Status van de taak.

Error

Foutdefinitie.

Name	Type	Description
code	string	Servicespecifieke foutcode die fungeert als de substatus voor de HTTP-foutcode.
details	Error[]	Interne foutdetails.
innererror	InnerError	Een object met specifiekere informatie dan het huidige object over de fout.
message	string	Een door mensen leesbare weergave van de fout.

ErrorResponse

Foutreactie.

Name	Type	Description
error	Error	De foutdetails.

ImportJob

Een taak die een verwijzing bevat naar de uit te voeren bewerkingen, resultaten en metagegevens van de uitvoering.

Name	Type	Description
createdDateTime	string	Begintijd van de taak. De tijdstempel heeft RFC3339 indeling: yyyy-MM-ddTHH:mm:ssZ.
error	Error	Details van de fout(en) die zijn opgetreden bij het uitvoeren van de importtaak.
finishedDateTime	string	Eindtijd van de taak. De tijdstempel heeft RFC3339 indeling: yyyy-MM-ddTHH:mm:ssZ.
id	string	De id van de importtaak.
inputBlobUri	string	Het pad naar de invoer-Azure Storage-blob die bestand(en) bevat waarin de bewerkingen worden beschreven die in de taak moeten worden uitgevoerd.
lastActionDateTime	string	De laatste keer dat de service een actie heeft uitgevoerd vanuit de taak. De tijdstempel heeft RFC3339 indeling: yyyy-MM-ddTHH:mm:ssZ.
outputBlobUri	string	Het pad naar de uitvoer-Azure Storage-blob die de fouten en voortgangslogboeken van de importtaak bevat.
purgeDateTime	string	Tijdstip waarop de taak door de service van het systeem wordt verwijderd. De tijdstempel heeft RFC3339 indeling: yyyy-MM-ddTHH:mm:ssZ.
status	status	Status van de taak.

InnerError

Een specifiekere foutbeschrijving dan is opgegeven door de betreffende fout.

Name	Type	Description
code	string	Een specifiekere foutcode dan is opgegeven door de betreffende fout.
innererror	InnerError	Een object met specifiekere informatie dan het huidige object over de fout.

status

Status van de taak.

Name	Type	Description
cancelled	string
cancelling	string
failed	string
notstarted	string
running	string
succeeded	string