Dela via


Jobs - Get

Hämta ett jobb efter ID
Få information om ett jobb som körs eller slutförts efter jobb-ID.

GET https://{subdomain}.{baseDomain}/api/jobs/{jobId}?api-version=2022-07-31

URI-parametrar

Name I Obligatorisk Typ Description
baseDomain
path True

string

Basdomänen för alla Azure IoT Central-tjänstbegäranden.

jobId
path True

string

Unikt ID för jobbet.

Reguljärt uttrycksmönster: ^[a-zA-Z0-9_-]*$

subdomain
path True

string

Programmets underdomän.

api-version
query True

string

Den version av API:et som anropas.

Svar

Name Typ Description
200 OK

Job

Klart

Other Status Codes

Error

Ett felsvar som togs emot från IoT Central-tjänsten.

Sidhuvuden

x-ms-error-code: string

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

Get a job by ID

Exempelbegäran

GET https://appsubdomain.azureiotcentral.com/api/jobs/myJobId?api-version=2022-07-31

Exempelsvar

{
  "id": "myJobId",
  "displayName": "My Job",
  "group": "475cad48-b7ff-4a09-b51e-1a9021385453",
  "data": [
    {
      "type": "property",
      "target": "urn:1dgygpt7t:modelDefinition:02uwtefvdy",
      "path": "componentName.propertyName",
      "value": "updated value"
    }
  ],
  "status": "running"
}

Definitioner

Name Description
CloudPropertyJobData

Jobbdata för molnegenskap.

CommandJobData

Datadefinitionen för kommandojobbet.

DeviceTemplateMigrationJobData

Definitionen av jobbdata för migrering av enhetsmallar.

Error

Svarsfeldefinitionen.

ErrorDetails

Information om felet.

Job

Jobbdefinitionen.

JobBatch

Jobbbatchdefinitionen.

JobBatchType

Om batchbearbetning görs på ett angivet antal enheter eller en procentandel av de totala enheterna.

JobCancellationThreshold

Definitionen av tröskelvärde för uppsägning av jobb.

JobCancellationThresholdType

Om tröskelvärdet för annullering är per angivet antal enheter eller en procentandel av det totala antalet enheter.

JobProgress

förloppssammanfattning för ett schemalagt jobb.

PropertyJobData

Datadefinitionen för egenskapsjobb.

CloudPropertyJobData

Jobbdata för molnegenskap.

Name Typ Description
path

string

Sökvägen till målfunktionen i enhetsmallen.

target

string

Enhetsmallen som definierar målfunktionen för jobbet.

type string:

cloudProperty

Typ av jobbdata.

value

AnyValue

Det värde som används för att uppdatera målfunktionen, om det finns.

CommandJobData

Datadefinitionen för kommandojobbet.

Name Typ Description
path

string

Sökvägen till målfunktionen i enhetsmallen.

target

string

Enhetsmallen som definierar målfunktionen för jobbet.

type string:

command

Typ av jobbdata.

value

AnyValue

Det värde som används för att uppdatera målfunktionen, om det finns.

DeviceTemplateMigrationJobData

Definitionen av jobbdata för migrering av enhetsmallar.

Name Typ Description
template

string

Målenhetsmallen som enheterna ska migreras till.

type string:

deviceTemplateMigration

Typ av jobbdata.

Error

Svarsfeldefinitionen.

Name Typ Description
error

ErrorDetails

Felinformation för aktuell begäran.

ErrorDetails

Information om felet.

Name Typ Description
code

string

Felkod.

message

string

Information om felmeddelanden.

requestId

string

Korrelations-ID för aktuell begäran.

time

string

Tiden då felbegäran misslyckades.

Job

Jobbdefinitionen.

Name Typ Description
batch

JobBatch

Batchkonfigurationen för jobbet.

cancellationThreshold

JobCancellationThreshold

Tröskelvärdet för annullering för jobbet.

data JobData[]:

De funktioner som uppdateras av jobbet och de värden som de uppdateras med.

description

string

Detaljerad beskrivning av jobbet.

displayName

string

Visningsnamn för jobbet.

end

string

Jobbets sluttid

group

string

ID:t för den enhetsgrupp som jobbet ska köras på.

id

string

Unikt ID för jobbet.

organizations

string[]

Lista över organisationer av jobbet, endast en organisation stöds idag, flera organisationer kommer att stödjas snart.

progress

JobProgress

Förloppsstatistiken för jobbet.

scheduledJobId

string

ID för den schemalagda jobbdefinitionen som skapade det här jobbet.

start

string

Starttiden för jobbet

status

string

Anger om jobbet startar, körs osv.

JobBatch

Jobbbatchdefinitionen.

Name Typ Description
type

JobBatchType

Om batchbearbetning görs på ett angivet antal enheter eller en procentandel av de totala enheterna.

value

number

Antalet eller procentandelen enheter som batchbearbetningen görs på.

JobBatchType

Om batchbearbetning görs på ett angivet antal enheter eller en procentandel av de totala enheterna.

Name Typ Description
number

string

Jobb batchbearbetning baserat på antalet enheter.

percentage

string

Jobb batchbearbetningsbaserad procentandel av det totala antalet tillämpade enheter.

JobCancellationThreshold

Definitionen av tröskelvärde för uppsägning av jobb.

Name Typ Description
batch

boolean

Om tröskelvärdet för annullering gäller per batch eller för det övergripande jobbet.

type

JobCancellationThresholdType

Om tröskelvärdet för annullering är per angivet antal enheter eller en procentandel av det totala antalet enheter.

value

number

Antalet eller procentandelen enheter som tröskelvärdet för annullering tillämpas på.

JobCancellationThresholdType

Om tröskelvärdet för annullering är per angivet antal enheter eller en procentandel av det totala antalet enheter.

Name Typ Description
number

string

Tröskelvärde för uppsägning av jobb baserat på angivet antal enheter.

percentage

string

Tröskelvärde för uppsägning av jobb baserat på procentandelen av de totala enheterna.

JobProgress

förloppssammanfattning för ett schemalagt jobb.

Name Typ Description
completed

integer

Antalet entiteter som jobbet har slutförts för.

failed

integer

Antalet entiteter som jobbet misslyckades för.

pending

integer

Antalet entiteter som jobbet inte körs för ännu.

total

integer

Det totala antalet entiteter som jobbet har som mål.

PropertyJobData

Datadefinitionen för egenskapsjobb.

Name Typ Description
path

string

Sökvägen till målfunktionen i enhetsmallen.

target

string

Enhetsmallen som definierar målfunktionen för jobbet.

type string:

property

Typ av jobbdata.

value

AnyValue

Det värde som används för att uppdatera målfunktionen, om det finns.