Long Running Operations - Get Operation State

Service:
Core
API-versie:
v1

Retourneert de huidige status van de langdurige bewerking.
U haalt de operationId op uit de header x-ms-operation-id die wordt geretourneerd door de API die de bewerking heeft gestart. Zodra de bewerkingsstatus Geslaagd is, gebruikt u de API Voor het ophalen van bewerkingsresultaten om het resultaat op te halen.

Machtigingen

Hetzelfde als de machtigingen die zijn vereist voor de API die de bewerking heeft gestart.

Vereist gedelegeerd bereik

Hetzelfde als de bereiken die zijn vereist voor de API die de bewerking heeft gestart.

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft-identiteiten die in deze sectie worden vermeld.

Identiteit Ondersteuning
Gebruiker Ja
serviceprincipal en beheerde identiteiten Ja

gebruikersinterface

GET https://api.fabric.microsoft.com/v1/operations/{operationId}

URI-parameters

Name In Vereist Type Description
operationId
 path True

string (uuid)

De bewerkings-id

Antwoorden

Name Type Description
200 OK

OperationState

De aanvraag is voltooid.

Kopteksten

  • Location: string
  • Retry-After: integer
  • x-ms-operation-id: string
429 Too Many Requests

ErrorResponse

De servicesnelheidslimiet is overschreden. De server retourneert een Retry-After header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden.

Kopteksten

Retry-After: integer
Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

  • UnknownError: er is een fout opgetreden.

Voorbeelden

Get active long running operation example
Get completed long running operation example

Get active long running operation example

Voorbeeldaanvraag

GET https://api.fabric.microsoft.com/v1/operations/cfafbeb1-8037-4d0c-896e-a46fb27ff227

Voorbeeldrespons

Statuscode:
200 
Location: https://api.fabric.microsoft.com/operations/cfafbeb1-8037-4d0c-896e-a46fb27ff227
x-ms-operation-id: cfafbeb1-8037-4d0c-896e-a46fb27ff227
Retry-After: 20
{
  "status": "Running",
  "createdTimeUtc": "2023-09-13T14:56:18.477Z",
  "lastUpdatedTimeUtc": "2023-09-13T15:01:10.532Z",
  "percentComplete": 25
}

Get completed long running operation example

Voorbeeldaanvraag

GET https://api.fabric.microsoft.com/v1/operations/cfafbeb1-8037-4d0c-896e-a46fb27ff227

Voorbeeldrespons

Statuscode:
200 
Location: https://api.fabric.microsoft.com/operations/cfafbeb1-8037-4d0c-896e-a46fb27ff227/result
x-ms-operation-id: cfafbeb1-8037-4d0c-896e-a46fb27ff227
{
  "status": "Succeeded",
  "createdTimeUtc": "2023-09-13T14:56:18.477Z",
  "lastUpdatedTimeUtc": "2023-09-13T15:01:10.532Z",
  "percentComplete": 100
}

Definities

Name Description
ErrorRelatedResource

Het foutgerelateerde resourcedetailsobject.
ErrorResponse

Het foutbericht.
ErrorResponseDetails

De details van het foutbericht.
LongRunningOperationStatus

De huidige status van de bewerking. Er kunnen na verloop van tijd extra bewerkingsstatussen worden toegevoegd.
OperationState

Een object met een beschrijving van de details en de huidige status van een langdurige bewerking

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name Type Description
resourceId

string

De resource-id die betrokken is bij de fout.
resourceType

string

Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
isRetriable

boolean

Wanneer waar, kan de aanvraag opnieuw worden geprobeerd. Gebruik de Retry-After antwoordheader om de vertraging te bepalen, indien beschikbaar.
message

string

Een leesbare weergave van de fout.
moreDetails

ErrorResponseDetails[]

Lijst met aanvullende foutdetails.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.
requestId

string (uuid)

Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.

LongRunningOperationStatus

Opsomming

De huidige status van de bewerking. Er kunnen na verloop van tijd extra bewerkingsstatussen worden toegevoegd.

Waarde Description
Undefined

De status van de bewerking is niet gedefinieerd
NotStarted

De bewerking is niet gestart
Running

De bewerking wordt uitgevoerd
Succeeded

De bewerking is voltooid
Failed

De bewerking is mislukt

OperationState

Object

Een object met een beschrijving van de details en de huidige status van een langdurige bewerking

Name Type Description
createdTimeUtc

string (date-time)

De begindatum en -tijd van de bewerking
error

ErrorResponse

De foutdetails voor het geval de bewerking de status Mislukt heeft
lastUpdatedTimeUtc

string (date-time)

De datum en tijd van de laatste wijziging in de bewerking
percentComplete

integer (int32)

minimum: 0
maximum: 100

Voortgang van de bewerking als percentage
status

LongRunningOperationStatus

De huidige status van de bewerking. Er kunnen na verloop van tijd extra bewerkingsstatussen worden toegevoegd.