Jobs - Get

Usługa:

IoT Central

Wersja interfejsu API:

2022-07-31

Pobieranie zadania według identyfikatora
Uzyskaj szczegółowe informacje o uruchomionym lub ukończonym zadaniu według identyfikatora zadania.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
baseDomain	path	True	string	Domena podstawowa dla wszystkich żądań obsługi usługi Azure IoT Central.
jobId	path	True	string maxLength: 255 pattern: ^[a-zA-Z0-9_-]*$	Unikatowy identyfikator zadania.
subdomain	path	True	string	Poddomena aplikacji.
api-version	query	True	string	Wywoływana wersja interfejsu API.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Job	Powodzenie
Other Status Codes	Error	Odebrano odpowiedź o błędzie z usługi IoT Central. Nagłówki x-ms-error-code: string

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Get a job by ID

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

200

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

Definicje

Nazwa	Opis
CloudPropertyJobData	Dane zadania właściwości w chmurze.
CommandJobData	Definicja danych zadania polecenia.
DeviceTemplateMigrationJobData	Definicja danych zadania migracji szablonu urządzenia.
Error	Definicja błędu odpowiedzi.
ErrorDetails	Szczegółowe informacje o błędzie.
Job	Definicja zadania.
JobBatch	Definicja partii zadań.
JobBatchType	Określa, czy przetwarzanie wsadowe odbywa się na określonej liczbie urządzeń, czy procent całkowitej liczby urządzeń.
JobCancellationThreshold	Definicja progu anulowania zadania.
JobCancellationThresholdType	Określa, czy próg anulowania przypada na określoną liczbę urządzeń, czy wartość procentową całkowitej liczby urządzeń.
JobProgress	podsumowanie postępu zaplanowanego zadania.
PropertyJobData	Definicja danych zadania właściwości.

CloudPropertyJobData

Objekt

Dane zadania właściwości w chmurze.

Nazwa	Typ	Opis
path	string	Ścieżka do możliwości docelowej w szablonie urządzenia.
target	string minLength: 1	Szablon urządzenia, który definiuje możliwości docelowe zadania.
type	string: cloudProperty	Typ danych zadania.
value	AnyValue	Wartość używana do aktualizowania możliwości docelowej, jeśli istnieje.

CommandJobData

Objekt

Definicja danych zadania polecenia.

Nazwa	Typ	Opis
path	string	Ścieżka do możliwości docelowej w szablonie urządzenia.
target	string minLength: 1	Szablon urządzenia, który definiuje możliwości docelowe zadania.
type	string: command	Typ danych zadania.
value	AnyValue	Wartość używana do aktualizowania możliwości docelowej, jeśli istnieje.

DeviceTemplateMigrationJobData

Objekt

Definicja danych zadania migracji szablonu urządzenia.

Nazwa	Typ	Opis
template	string minLength: 1	Szablon urządzenia docelowego, do którego zostaną zmigrowane urządzenia.
type	string: deviceTemplateMigration	Typ danych zadania.

Error

Objekt

Definicja błędu odpowiedzi.

Nazwa	Typ	Opis
error	ErrorDetails	Szczegóły błędu dla bieżącego żądania.

ErrorDetails

Objekt

Szczegółowe informacje o błędzie.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Szczegóły komunikatu o błędzie.
requestId	string	Identyfikator korelacji dla bieżącego żądania.
time	string (date-time-rfc1123)	Czas niepowodzenia żądania błędu.

Job

Objekt

Definicja zadania.

Nazwa	Typ	Opis
batch	JobBatch	Konfiguracja przetwarzania wsadowego dla zadania.
cancellationThreshold	JobCancellationThreshold	Próg anulowania zadania.
data	JobData[]: CloudPropertyJobData[] CommandJobData[] DeviceTemplateMigrationJobData[] PropertyJobData[]	Możliwości aktualizowane przez zadanie oraz wartości, za pomocą których są aktualizowane.
description	string	Szczegółowy opis zadania.
displayName	string	Nazwa wyświetlana zadania.
end	string (date-time)	Godzina zakończenia zadania
group	string	Identyfikator grupy urządzeń, na której ma zostać wykonane zadanie.
id	string	Unikatowy identyfikator zadania.
organizations	string[]	Lista organizacji zadania, tylko jedna organizacja jest obecnie obsługiwana, wiele organizacji będzie obsługiwanych wkrótce.
progress	JobProgress	Statystyki postępu zadania.
scheduledJobId	string	Identyfikator definicji zaplanowanego zadania, która utworzyła to zadanie.
start	string (date-time)	Godzina rozpoczęcia zadania
status	string	Wskazuje, czy zadanie jest uruchamiane, uruchomione itp.

JobBatch

Objekt

Definicja partii zadań.

Nazwa	Typ	Opis
type	JobBatchType	Określa, czy przetwarzanie wsadowe odbywa się na określonej liczbie urządzeń, czy procent całkowitej liczby urządzeń.
value	number	Liczba lub procent urządzeń, na których odbywa się przetwarzanie wsadowe.

JobBatchType

Wyliczanie

Określa, czy przetwarzanie wsadowe odbywa się na określonej liczbie urządzeń, czy procent całkowitej liczby urządzeń.

Wartość	Opis
number	Przetwarzanie wsadowe zadań na podstawie liczby urządzeń.
percentage	Procent łącznej liczby zastosowanych urządzeń na podstawie dzielenia zadań na partie.

JobCancellationThreshold

Objekt

Definicja progu anulowania zadania.

Nazwa	Typ	Opis
batch	boolean	Niezależnie od tego, czy próg anulowania ma zastosowanie do partii, czy do ogólnego zadania.
type	JobCancellationThresholdType	Określa, czy próg anulowania przypada na określoną liczbę urządzeń, czy wartość procentową całkowitej liczby urządzeń.
value	number	Liczba lub procent urządzeń, na których jest stosowany próg anulowania.

JobCancellationThresholdType

Wyliczanie

Określa, czy próg anulowania przypada na określoną liczbę urządzeń, czy wartość procentową całkowitej liczby urządzeń.

Wartość	Opis
number	Próg anulowania zadania na podstawie określonej liczby urządzeń.
percentage	Próg anulowania zadania na podstawie wartości procentowej całkowitej liczby urządzeń.

JobProgress

Objekt

podsumowanie postępu zaplanowanego zadania.

Nazwa	Typ	Opis
completed	integer (int32)	Liczba jednostek, dla których zadanie zostało ukończone.
failed	integer (int32)	Liczba jednostek, dla których zadanie zakończyło się niepowodzeniem.
pending	integer (int32)	Liczba jednostek, dla których zadanie nie jest jeszcze uruchomione.
total	integer (int32)	Całkowita liczba jednostek objętych zadaniem.

PropertyJobData

Objekt

Definicja danych zadania właściwości.

Nazwa	Typ	Opis
path	string	Ścieżka do możliwości docelowej w szablonie urządzenia.
target	string minLength: 1	Szablon urządzenia, który definiuje możliwości docelowe zadania.
type	string: property	Typ danych zadania.
value	AnyValue	Wartość używana do aktualizowania możliwości docelowej, jeśli istnieje.