Sdílet prostřednictvím


Jobs - Get

Získání úlohy podle ID
Získejte podrobnosti o spuštěné nebo dokončené úloze podle ID úlohy.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
baseDomain
path True

string

Základní doména pro všechny žádosti o službu Azure IoT Central.

jobId
path True

string

Jedinečné ID úlohy

Vzor regulárního výrazu: ^[a-zA-Z0-9_-]*$

subdomain
path True

string

Subdoména aplikace.

api-version
query True

string

Verze volaného rozhraní API

Odpovědi

Name Typ Description
200 OK

Job

Success

Other Status Codes

Error

Služba IoT Central přijala chybovou odpověď.

Hlavičky

x-ms-error-code: string

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

Get a job by ID

Ukázkový požadavek

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

Ukázková odpověď

{
  "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"
}

Definice

Name Description
CloudPropertyJobData

Data úlohy vlastností cloudu.

CommandJobData

Definice dat úlohy příkazu

DeviceTemplateMigrationJobData

Definice dat úlohy migrace šablony zařízení

Error

Definice chyby odpovědi.

ErrorDetails

Podrobné informace o chybě.

Job

Definice úlohy

JobBatch

Definice dávky úlohy.

JobBatchType

Určuje, jestli se dávkování provádí na zadaném počtu zařízení nebo v procentech z celkového počtu zařízení.

JobCancellationThreshold

Definice prahové hodnoty zrušení úlohy

JobCancellationThresholdType

Určuje, jestli prahová hodnota zrušení odpovídá zadanému počtu zařízení nebo procentu z celkového počtu zařízení.

JobProgress

souhrn průběhu pro naplánovanou úlohu.

PropertyJobData

Definice dat úlohy vlastnosti.

CloudPropertyJobData

Data úlohy vlastností cloudu.

Name Typ Description
path

string

Cesta k cílové funkci v rámci šablony zařízení.

target

string

Šablona zařízení, která definuje cílovou schopnost úlohy.

type string:

cloudProperty

Typ dat úlohy.

value

AnyValue

Hodnota použitá k aktualizaci cílové schopnosti, pokud existuje.

CommandJobData

Definice dat úlohy příkazu

Name Typ Description
path

string

Cesta k cílové funkci v rámci šablony zařízení.

target

string

Šablona zařízení, která definuje cílovou schopnost úlohy.

type string:

command

Typ dat úlohy.

value

AnyValue

Hodnota použitá k aktualizaci cílové schopnosti, pokud existuje.

DeviceTemplateMigrationJobData

Definice dat úlohy migrace šablony zařízení

Name Typ Description
template

string

Šablona cílového zařízení, do kterého se budou migrovat zařízení.

type string:

deviceTemplateMigration

Typ dat úlohy.

Error

Definice chyby odpovědi.

Name Typ Description
error

ErrorDetails

Podrobnosti o chybě pro aktuální požadavek

ErrorDetails

Podrobné informace o chybě.

Name Typ Description
code

string

Kód chyby

message

string

Podrobnosti o chybové zprávě

requestId

string

ID korelace pro aktuální požadavek.

time

string

Čas, kdy žádost o chybu selhala.

Job

Definice úlohy

Name Typ Description
batch

JobBatch

Konfigurace dávkování pro úlohu

cancellationThreshold

JobCancellationThreshold

Prahová hodnota zrušení pro úlohu.

data JobData[]:

Možnosti, které úloha aktualizuje, a hodnoty, se kterými se aktualizují.

description

string

Podrobný popis úlohy.

displayName

string

Zobrazovaný název úlohy

end

string

Čas ukončení úlohy

group

string

ID skupiny zařízení, na které se má úloha spustit.

id

string

Jedinečné ID úlohy

organizations

string[]

Seznam organizací úlohy, v současné době je podporována pouze jedna organizace, brzy bude podporováno více organizací.

progress

JobProgress

Statistika průběhu úlohy.

scheduledJobId

string

ID definice naplánované úlohy, která vytvořila tuto úlohu.

start

string

Čas spuštění úlohy

status

string

Označuje, jestli se úloha spouští, běží atd.

JobBatch

Definice dávky úlohy.

Name Typ Description
type

JobBatchType

Určuje, jestli se dávkování provádí na zadaném počtu zařízení nebo v procentech z celkového počtu zařízení.

value

number

Počet nebo procento zařízení, na kterých se dávkování provádí.

JobBatchType

Určuje, jestli se dávkování provádí na zadaném počtu zařízení nebo v procentech z celkového počtu zařízení.

Name Typ Description
number

string

Dávkování úloh na základě počtu zařízení.

percentage

string

Procento celkového použitého zařízení založeného na dávce úloh

JobCancellationThreshold

Definice prahové hodnoty zrušení úlohy

Name Typ Description
batch

boolean

Určuje, jestli se prahová hodnota zrušení vztahuje na dávku nebo na celkovou úlohu.

type

JobCancellationThresholdType

Určuje, jestli prahová hodnota zrušení odpovídá zadanému počtu zařízení nebo procentu z celkového počtu zařízení.

value

number

Počet nebo procento zařízení, u kterých se použije prahová hodnota zrušení.

JobCancellationThresholdType

Určuje, jestli prahová hodnota zrušení odpovídá zadanému počtu zařízení nebo procentu z celkového počtu zařízení.

Name Typ Description
number

string

Prahová hodnota zrušení úlohy na základě zadaného počtu zařízení.

percentage

string

Prahová hodnota zrušení úlohy na základě procenta celkového počtu zařízení.

JobProgress

souhrn průběhu pro naplánovanou úlohu.

Name Typ Description
completed

integer

Počet entit, pro které se úloha dokončila.

failed

integer

Počet entit, pro které úloha selhala.

pending

integer

Počet entit, pro které úloha ještě není spuštěná.

total

integer

Celkový počet entit, na které úloha cílí.

PropertyJobData

Definice dat úlohy vlastnosti.

Name Typ Description
path

string

Cesta k cílové funkci v rámci šablony zařízení.

target

string

Šablona zařízení, která definuje cílovou schopnost úlohy.

type string:

property

Typ dat úlohy.

value

AnyValue

Hodnota použitá k aktualizaci cílové schopnosti, pokud existuje.