Long Running Operations - Get Operation State

Služba:

Core

Verze rozhraní API:

v1

Vrátí aktuální stav dlouhotrvající operace.
Id operace získáte z hlavičky x-ms-operation-id vrácenou rozhraním API, které operaci zahájilo. Jakmile je stav operace Úspěch, použijte rozhraní API pro získání výsledku operace k načtení výsledku.

Povolení

Stejné jako oprávnění požadovaná pro rozhraní API, které operaci iniciovalo.

Požadovaný delegovaný obor

Stejné jako obory vyžadované pro rozhraní API, které operaci iniciovalo.

Podporované identity v Microsoft Entra

Toto rozhraní API podporuje identity Microsoft uvedené v této části.

Identita	Podpora
Uživatel	Ano
Hlavní služba a Spravované identity	Ano

Rozhraní

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
operationId	path	True	string (uuid)	Identifikátor operace

Odpovědi

Name	Typ	Description
200 OK	OperationState	Žádost byla úspěšně dokončena. Hlavičky Location: string Retry-After: integer x-ms-operation-id: string
429 Too Many Requests	ErrorResponse	Byl překročen limit přenosové rychlosti služby. Server vrátí hlavičku označující Retry-After , jak dlouho musí klient čekat před odesláním dalších požadavků. Hlavičky Retry-After: integer
Other Status Codes	ErrorResponse	Běžné kódy chyb: Neznámá chyba – došlo k chybě.

Příklady

Get active long running operation example

Get completed long running operation example

Get active long running operation example

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

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

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

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
}

Definice

Name	Description
ErrorRelatedResource	Chyba související s objektem podrobností o prostředku.
ErrorResponse	Odpověď na chybu.
ErrorResponseDetails	Podrobnosti o odpovědi na chybu.
LongRunningOperationStatus	Aktuální stav operace. V průběhu času se můžou přidat další stavy operací.
OperationState	Objekt popisující podrobnosti a aktuální stav dlouhotrvající operace

ErrorRelatedResource

Objekt

Chyba související s objektem podrobností o prostředku.

Name	Typ	Description
resourceId	string	ID prostředku, které je součástí chyby.
resourceType	string	Typ prostředku, který je součástí chyby.

ErrorResponse

Objekt

Odpověď na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message	string	Lidské čitelné vyjádření chyby.
moreDetails	ErrorResponseDetails[]	Seznam dalších podrobností o chybě
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou
requestId	string (uuid)	ID požadavku přidruženého k chybě.

ErrorResponseDetails

Objekt

Podrobnosti o odpovědi na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message	string	Lidské čitelné vyjádření chyby.
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou

LongRunningOperationStatus

Výčet

Aktuální stav operace. V průběhu času se můžou přidat další stavy operací.

Hodnota	Description
Undefined	Stav operace není definován.
NotStarted	Operace se nespusila.
Running	Operace je spuštěná.
Succeeded	Operace byla úspěšně dokončena.
Failed	Operace se nezdařila.

OperationState

Objekt

Objekt popisující podrobnosti a aktuální stav dlouhotrvající operace

Name	Typ	Description
createdTimeUtc	string (date-time)	Počáteční datum a čas operace
error	ErrorResponse	Podrobnosti o chybě v případě, že je operace ve stavu selhání
lastUpdatedTimeUtc	string (date-time)	Datum a čas poslední změny operace
percentComplete	integer (int32) minimum: 0 maximum: 100	Průběh operace jako procento
status	LongRunningOperationStatus	Aktuální stav operace. V průběhu času se můžou přidat další stavy operací.