Job Scheduler - List Item Job Instances

Referens

Tjänst:: Core

API-version:: v1

Returnerar en lista över jobbinstanser för det angivna objektet.

Obligatoriska delegerade omfång

För objekt-API:er använder du följande omfångstyper:

Allmänt omfång: Item.ReadWrite.All eller Item.Read.All
Specifikt omfång: itemType. ReadWrite.All eller itemType. Read.All (till exempel: Notebook.ReadWrite.All)

Mer information om omfång finns i artikeln om omfång.

Begränsningar

De flesta objekt har en gräns på 100 nyligen slutförda entiteter och det finns ingen gräns för aktiva entiteter.

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet	Stöd
Användare	Ja
Tjänsthuvudnamn och hanterade identiteter	Ja

Gränssnitt

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/jobs/instances

Med valfria parametrar:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/jobs/instances?continuationToken={continuationToken}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
itemId	path	True	string (uuid)	Objekt-ID:t.
workspaceId	path	True	string (uuid)	Arbetsyte-ID.
continuationToken	query		string	En token för att hämta nästa sida med resultat.

Svar

Name	Typ	Description
200 OK	ItemJobInstances	Begäran har slutförts.
Other Status Codes	ErrorResponse	Vanliga felkoder: InsufficientPrivileges – Anroparen har inte tillräcklig behörighet för att komma åt objektet. ItemNotFound – Det gick inte att hitta det begärda objekt-ID:t.

Name

Typ

Description

200 OK

ItemJobInstances

Begäran har slutförts.

Other Status Codes

ErrorResponse

Vanliga felkoder:

InsufficientPrivileges – Anroparen har inte tillräcklig behörighet för att komma åt objektet.
ItemNotFound – Det gick inte att hitta det begärda objekt-ID:t.

Exempel

List item job instances example

List item job instances with continuation example

List item job instances example

Exempelbegäran

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances

Exempelsvar

Statuskod:: 200

{
  "value": [
    {
      "id": "f2d65699-dd22-4889-980c-15226deb0e1b",
      "itemId": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
      "jobType": "DefaultJob",
      "invokeType": "Manual",
      "status": "Completed",
      "rootActivityId": "8c2ee553-53a4-7edb-1042-0d8189a9e0ca",
      "startTimeUtc": "2024-06-22T06:35:00.7812154",
      "endTimeUtc": "2024-06-22T06:35:00.8033333",
      "failureReason": null
    },
    {
      "id": "c0c99aed-be56-4fe0-a6e5-6de5fe277f16",
      "itemId": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
      "jobType": "DefaultJob",
      "invokeType": "Manual",
      "status": "Completed",
      "rootActivityId": "c0c99aed-be56-4fe0-a6e5-6de5fe277f16",
      "startTimeUtc": "2024-06-22T06:35:00.7812154",
      "endTimeUtc": "2024-06-22T07:35:00.8033333",
      "failureReason": null
    }
  ]
}

List item job instances with continuation example

Exempelbegäran

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances

Exempelsvar

Statuskod:: 200

{
  "value": [
    {
      "id": "f2d65699-dd22-4889-980c-15226deb0e1b",
      "itemId": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
      "jobType": "DefaultJob",
      "invokeType": "Manual",
      "status": "Completed",
      "rootActivityId": "8c2ee553-53a4-7edb-1042-0d8189a9e0ca",
      "startTimeUtc": "2024-06-22T06:35:00.7812154",
      "endTimeUtc": "2024-06-22T06:35:00.8033333",
      "failureReason": null
    },
    {
      "id": "c0c99aed-be56-4fe0-a6e5-6de5fe277f16",
      "itemId": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
      "jobType": "DefaultJob",
      "invokeType": "Manual",
      "status": "Completed",
      "rootActivityId": "c0c99aed-be56-4fe0-a6e5-6de5fe277f16",
      "startTimeUtc": "2024-06-22T06:35:00.7812154",
      "endTimeUtc": "2024-06-22T07:35:00.8033333",
      "failureReason": null
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances?continuationToken=LDEsMTAwMDAwLDA%3D"
}

Definitioner

Name	Description
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
InvokeType	Objektjobbet anropar typ. Ytterligare invokeTypes kan läggas till över tid.
ItemJobInstance	Ett objekt som representerar objektjobbsinstansen
ItemJobInstances
Status	Status för objektjobbet. Ytterligare statusar kan läggas till över tid.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name	Typ	Description
resourceId	string	Det resurs-ID som ingår i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.
requestId	string	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.

InvokeType

Uppräkning

Objektjobbet anropar typ. Ytterligare invokeTypes kan läggas till över tid.

Värde	Description
Manual	Jobbet anropas manuellt
Scheduled	Jobbet är schemalagt

ItemJobInstance

Objekt

Ett objekt som representerar objektjobbsinstansen

Name	Typ	Description
endTimeUtc	string	Jobbsluttid i UTC
failureReason	ErrorResponse	Felsvar när jobbet misslyckades
id	string (uuid)	Jobbinstans-ID
invokeType	InvokeType	Objektjobbet anropar typ. Ytterligare invokeTypes kan läggas till över tid.
itemId	string (uuid)	Objekt-ID
jobType	string	Jobbtyp
rootActivityId	string	Rotaktivitets-ID för att spåra begäranden mellan tjänster
startTimeUtc	string	Starttid för jobb i UTC
status	Status	Status för objektjobbet. Ytterligare statusar kan läggas till över tid.

ItemJobInstances

Objekt

Name	Typ	Description
continuationToken	string	Token för nästa resultatuppsättningsbatch. Om det inte finns några fler poster tas den bort från svaret.
continuationUri	string	URI:n för nästa resultatuppsättningsbatch. Om det inte finns några fler poster tas den bort från svaret.
value	ItemJobInstance[]	En lista över objektjobbsinstanser.

Status

Uppräkning

Status för objektjobbet. Ytterligare statusar kan läggas till över tid.

Värde	Description
Cancelled	Jobbet avbröts
Completed	Jobbet har slutförts
Deduped	En jobbinstans av samma jobbtyp körs redan och den här jobbinstansen hoppas över
Failed	Jobbet misslyckades
InProgress	Jobbet pågår
NotStarted	Jobbet har inte startats

Dela via

Job Scheduler - List Item Job Instances

Obligatoriska delegerade omfång

Begränsningar

Identiteter som stöds av Microsoft Entra

Gränssnitt

URI-parametrar

Svar

Exempel

List item job instances example

Exempelbegäran

Exempelsvar

List item job instances with continuation example

Exempelbegäran

Exempelsvar

Definitioner

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

InvokeType

ItemJobInstance

ItemJobInstances

Status