Jobs - Get Item Job Instance State

Szolgáltatás:

Workload Development

API-verzió:

v1

A Microsoft Fabric meghívta egy feladatpéldány állapotának lekéréséhez.
A Fabric alapvető ellenőrzéseket végez, és meghívja ezt az API-t az elemfeladat-példány állapotának lekéréséhez a számítási feladatban.

Ennek az API-nak el kell fogadnia a SubjectAndApp-hitelesítést.

Engedélyek

Az engedélyeket a Microsoft Fabric ellenőrzi.

GET https://workload.contoso.com/workload-api-path-placeholder/workspaces/{workspaceId}/items/{itemType}/{itemId}/jobTypes/{jobType}/instances/{jobInstanceId}

URI-paraméterek

Name	In	Kötelező	Típus	Description
itemId	path	True	string uuid	Az elem azonosítója.
itemType	path	True	string	Az elem típusa.
jobInstanceId	path	True	string uuid	A feladatpéldány azonosítója.
jobType	path	True	string	A feladat típusa.
workspaceId	path	True	string uuid	A munkaterület azonosítója.

Kérelem fejléce

Name	Kötelező	Típus	Description
ActivityId	True	string	Egyedi azonosító a kérés és a rendszer közötti korrelációhoz, amikor egy felhasználó interakcióba lép a számítási feladattal.
RequestId	True	string	Egy globálisan egyedi azonosító, amely segít a Fabricnek korrelálni a kérését a naplókkal. Adja meg ezt az azonosítót egy probléma jelentésekor.
Authorization	True	string	Kettős jogkivonat-engedélyezési fejléc, amely lehetővé teszi a számítási feladat számára a kérés forrásának ellenőrzését, a felhasználói környezet biztosítását és más szolgáltatások hívását. A fejléc formátuma a következő: SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token".
x-ms-client-tenant-id	True	string	A kérelmet küldő ügyfél bérlőazonosítója.

Válaszok

Name	Típus	Description
200 OK	ItemJobInstanceState	Sikeresen befejeződött.
Other Status Codes	ErrorResponse	Hibafeltételek esetén a számítási feladatnak egy megfelelő HTTP-hibaállapot-kódot (4xx, 5xx) kell visszaadnia, amely részletes hibainformációkat tartalmaz a válasz törzsében.

Példák

Get item job instance state example

Mintakérelem

HTTP

GET https://workload.contoso.com/workload-api-path-placeholder/workspaces/e5ef604d-e14f-4a59-9133-75d5a0cb9334/items/Contoso.FinanceAnalytics.Forecast/b14cb7e7-d346-4751-9cfd-8c2767d53111/jobTypes/calculateForecast/instances/63f77191-432d-4ee6-9c5f-31a1a6987072

Mintaválasz

Állapotkód:

200

{
  "status": "InProgress",
  "startTimeUtc": "2023-12-10T14:41:39.412Z"
}

Definíciók

Name	Description
ErrorDetails	A hiba részletei.
ErrorExtendedInformation	A kiterjesztett hibainformációk.
ErrorResponse	A hibaválasz.
ErrorSource	A hiba forrása.
ItemJobInstanceState	A feladatpéldány állapota.
JobInstanceStatus	Egy elemfeladat-példány állapota.
NameValuePair	Név-érték pár.

ErrorDetails

Objektum

A hiba részletei.

Name	Típus	Description
errorCode	string	A hibakód.
isPermanent	boolean	Azt jelzi, hogy a hiba végleges-e, vagy a művelet újrapróbálkozott-e.
message	string	A hibaüzenet.
messageParameters	string[]	A honosított üzenetek formázására szolgáló paraméterek listája.
moreDetails	ErrorExtendedInformation[]	További hibaadatok listája.
source	ErrorSource	A hiba forrása.

ErrorExtendedInformation

Objektum

A kiterjesztett hibainformációk.

Name	Típus	Description
additionalParameters	NameValuePair[]	A hibára jellemző további paraméterek listája.
errorCode	string	A hibakód.
message	string	A hibaüzenet.
messageParameters	string[]	A honosított üzenetek formázására szolgáló paraméterek listája.

ErrorResponse

Objektum

A hibaválasz.

Name	Típus	Description
errorCode	string	A hibakód.
isPermanent	boolean	Azt jelzi, hogy a hiba végleges-e, vagy a művelet újrapróbálkozott-e.
message	string	A hibaüzenet.
messageParameters	string[]	A honosított üzenetek formázására szolgáló paraméterek listája.
moreDetails	ErrorExtendedInformation[]	További hibaadatok listája.
source	ErrorSource	A hiba forrása.

ErrorSource

Enumerálás

A hiba forrása.

Érték	Description
External
System
User

ItemJobInstanceState

Objektum

A feladatpéldány állapota.

Name	Típus	Description
endTimeUtc	string date-time	A feladatpéldány befejezési ideje.
errorDetails	ErrorDetails	A hiba részletei a feladatpéldány meghibásodása esetén.
startTimeUtc	string date-time	A feladatpéldány kezdési időpontja.
status	JobInstanceStatus	A feladatpéldány állapota.

JobInstanceStatus

Enumerálás

Egy elemfeladat-példány állapota.

Érték	Description
Cancelled
Completed
Failed
InProgress
NotStarted

NameValuePair

Objektum

Név-érték pár.

Name	Típus	Description
name	string	A név.
value	string	Az érték.