Jobs - Get

서비스:

IoT Central

API 버전:

2022-07-31

ID로 작업 가져오기
작업 ID를 사용하여 실행 중이거나 완료된 작업에 대한 세부 정보를 가져옵니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
baseDomain	path	True	string	모든 Azure IoT Central 서비스 요청에 대한 기본 도메인입니다.
jobId	path	True	string maxLength: 255 pattern: ^[a-zA-Z0-9_-]*$	작업의 고유 ID입니다.
subdomain	path	True	string	애플리케이션 하위 도메인입니다.
api-version	query	True	string	호출되는 API의 버전입니다.

응답

Name	형식	Description
200 OK	Job	성공
Other Status Codes	Error	IoT Central 서비스에서 받은 오류 응답입니다. 헤더 x-ms-error-code: string

보안

azure_auth

Azure Active Directory OAuth2 흐름

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

Get a job by ID

샘플 요청

HTTP

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

샘플 응답

상태 코드:

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

정의

Name	Description
CloudPropertyJobData	클라우드 속성 작업 데이터입니다.
CommandJobData	명령 작업 데이터 정의입니다.
DeviceTemplateMigrationJobData	디바이스 템플릿 마이그레이션 작업 데이터 정의입니다.
Error	응답 오류 정의입니다.
ErrorDetails	오류의 세부 정보입니다.
Job	작업 정의입니다.
JobBatch	작업 일괄 처리 정의입니다.
JobBatchType	지정된 수의 디바이스에서 일괄 처리가 수행되는지 또는 전체 디바이스의 백분율인지 여부입니다.
JobCancellationThreshold	작업 취소 임계값 정의입니다.
JobCancellationThresholdType	취소 임계값이 지정된 디바이스 수 또는 총 디바이스의 백분율에 해당하는지 여부입니다.
JobProgress	예약된 작업에 대한 진행률 요약입니다.
PropertyJobData	속성 작업 데이터 정의입니다.

CloudPropertyJobData

Object

클라우드 속성 작업 데이터입니다.

Name	형식	Description
path	string	디바이스 템플릿 내의 대상 기능에 대한 경로입니다.
target	string minLength: 1	작업의 대상 기능을 정의하는 디바이스 템플릿입니다.
type	string: cloudProperty	작업 데이터의 형식입니다.
value	AnyValue	대상 기능을 업데이트하는 데 사용되는 값(있는 경우)입니다.

CommandJobData

Object

명령 작업 데이터 정의입니다.

Name	형식	Description
path	string	디바이스 템플릿 내의 대상 기능에 대한 경로입니다.
target	string minLength: 1	작업의 대상 기능을 정의하는 디바이스 템플릿입니다.
type	string: command	작업 데이터의 형식입니다.
value	AnyValue	대상 기능을 업데이트하는 데 사용되는 값(있는 경우)입니다.

DeviceTemplateMigrationJobData

Object

디바이스 템플릿 마이그레이션 작업 데이터 정의입니다.

Name	형식	Description
template	string minLength: 1	디바이스를 마이그레이션할 대상 디바이스 템플릿입니다.
type	string: deviceTemplateMigration	작업 데이터의 형식입니다.

Error

Object

응답 오류 정의입니다.

Name	형식	Description
error	ErrorDetails	현재 요청에 대한 오류 세부 정보입니다.

ErrorDetails

Object

오류의 세부 정보입니다.

Name	형식	Description
code	string	오류 코드입니다.
message	string	오류 메시지 세부 정보입니다.
requestId	string	현재 요청에 대한 상관 관계 ID입니다.
time	string (date-time-rfc1123)	오류 요청이 실패한 시간입니다.

Job

Object

작업 정의입니다.

Name	형식	Description
batch	JobBatch	작업에 대한 일괄 처리 구성입니다.
cancellationThreshold	JobCancellationThreshold	작업의 취소 임계값입니다.
data	JobData[]: CloudPropertyJobData[] CommandJobData[] DeviceTemplateMigrationJobData[] PropertyJobData[]	작업에서 업데이트되는 기능 및 업데이트되는 값입니다.
description	string	작업에 대한 자세한 설명입니다.
displayName	string	작업의 표시 이름입니다.
end	string (date-time)	작업의 종료 시간
group	string	작업을 실행할 디바이스 그룹의 ID입니다.
id	string	작업의 고유 ID입니다.
organizations	string[]	작업 조직 목록, 현재 하나의 조직만 지원되며, 곧 여러 조직이 지원될 예정입니다.
progress	JobProgress	작업의 진행률 통계입니다.
scheduledJobId	string	이 작업을 만든 예약된 작업 정의의 ID입니다.
start	string (date-time)	작업의 시작 시간
status	string	작업이 시작, 실행 중인지 여부를 나타냅니다.

JobBatch

Object

작업 일괄 처리 정의입니다.

Name	형식	Description
type	JobBatchType	지정된 수의 디바이스에서 일괄 처리가 수행되는지 또는 전체 디바이스의 백분율인지 여부입니다.
value	number	일괄 처리가 수행되는 디바이스의 수 또는 백분율입니다.

JobBatchType

열거형

지정된 수의 디바이스에서 일괄 처리가 수행되는지 또는 전체 디바이스의 백분율인지 여부입니다.

값	Description
number	디바이스 수에 따라 작업 일괄 처리
percentage	적용된 총 디바이스의 작업 일괄 처리 기반 백분율입니다.

JobCancellationThreshold

Object

작업 취소 임계값 정의입니다.

Name	형식	Description
batch	boolean	취소 임계값이 일괄 처리당 적용되는지 전체 작업에 적용되는지 여부입니다.
type	JobCancellationThresholdType	취소 임계값이 지정된 디바이스 수 또는 총 디바이스의 백분율에 해당하는지 여부입니다.
value	number	취소 임계값이 적용되는 디바이스의 수 또는 백분율입니다.

JobCancellationThresholdType

열거형

취소 임계값이 지정된 디바이스 수 또는 총 디바이스의 백분율에 해당하는지 여부입니다.

값	Description
number	지정된 디바이스 수에 따른 작업 취소 임계값입니다.
percentage	총 디바이스의 백분율을 기준으로 하는 작업 취소 임계값입니다.

JobProgress

Object

예약된 작업에 대한 진행률 요약입니다.

Name	형식	Description
completed	integer (int32)	작업이 완료된 엔터티 수입니다.
failed	integer (int32)	작업이 실패한 엔터티 수입니다.
pending	integer (int32)	작업이 아직 실행되고 있지 않은 엔터티의 수입니다.
total	integer (int32)	작업의 대상이 되는 총 엔터티 수입니다.

PropertyJobData

Object

속성 작업 데이터 정의입니다.

Name	형식	Description
path	string	디바이스 템플릿 내의 대상 기능에 대한 경로입니다.
target	string minLength: 1	작업의 대상 기능을 정의하는 디바이스 템플릿입니다.
type	string: property	작업 데이터의 형식입니다.
value	AnyValue	대상 기능을 업데이트하는 데 사용되는 값(있는 경우)입니다.