Jobs - Get

服务:

IoT Central

API 版本:

2022-07-31

按 ID 获取作业
按作业 ID 获取有关正在运行或已完成的作业的详细信息。

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

URI 参数

名称	在	必需	类型	说明
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 的版本。

响应

名称	类型	说明
200 OK	Job	成功
Other Status Codes	Error	从 IoT Central 服务收到的错误响应。 标头 x-ms-error-code: string

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
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"
}

定义

名称	说明
CloudPropertyJobData	云属性作业数据。
CommandJobData	命令作业数据定义。
DeviceTemplateMigrationJobData	设备模板迁移作业数据定义。
Error	响应错误定义。
ErrorDetails	错误的详细信息。
Job	作业定义。
JobBatch	作业批处理定义。
JobBatchType	批处理是在指定数量的设备上完成还是对设备总数的百分比进行。
JobCancellationThreshold	作业取消阈值定义。
JobCancellationThresholdType	取消阈值是按指定数量的设备还是占设备总数的百分比。
JobProgress	计划作业的进度摘要。
PropertyJobData	属性作业数据定义。

CloudPropertyJobData

Object

云属性作业数据。

名称	类型	说明
path	string	设备模板中目标功能的路径。
target	string minLength: 1	定义作业的目标功能的设备模板。
type	string: cloudProperty	作业数据的类型。
value	AnyValue	用于更新目标功能（如果有）的值。

CommandJobData

Object

命令作业数据定义。

名称	类型	说明
path	string	设备模板中目标功能的路径。
target	string minLength: 1	定义作业的目标功能的设备模板。
type	string: command	作业数据的类型。
value	AnyValue	用于更新目标功能（如果有）的值。

DeviceTemplateMigrationJobData

Object

设备模板迁移作业数据定义。

名称	类型	说明
template	string minLength: 1	要迁移到的目标设备模板。
type	string: deviceTemplateMigration	作业数据的类型。

Error

Object

响应错误定义。

名称	类型	说明
error	ErrorDetails	当前请求的错误详细信息。

ErrorDetails

Object

错误的详细信息。

名称	类型	说明
code	string	错误代码。
message	string	错误消息详细信息。
requestId	string	当前请求的相关 ID。
time	string (date-time-rfc1123)	错误请求失败的时间。

Job

Object

作业定义。

名称	类型	说明
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

作业批处理定义。

名称	类型	说明
type	JobBatchType	批处理是在指定数量的设备上完成还是对设备总数的百分比进行。
value	number	完成批处理的设备的数量或百分比。

JobBatchType

枚举

批处理是在指定数量的设备上完成还是对设备总数的百分比进行。

值	说明
number	基于设备数的作业批处理。
percentage	基于已应用设备总数的作业批处理百分比。

JobCancellationThreshold

Object

作业取消阈值定义。

名称	类型	说明
batch	boolean	取消阈值是按批应用还是应用于整个作业。
type	JobCancellationThresholdType	取消阈值是按指定数量的设备还是占设备总数的百分比。
value	number	应用取消阈值的设备的数量或百分比。

JobCancellationThresholdType

枚举

取消阈值是按指定数量的设备还是占设备总数的百分比。

值	说明
number	基于指定数量的设备作业取消阈值。
percentage	基于设备总数的百分比的作业取消阈值。

JobProgress

Object

计划作业的进度摘要。

名称	类型	说明
completed	integer (int32)	作业已完成的实体数。
failed	integer (int32)	作业失败的实体数。
pending	integer (int32)	作业尚未运行的实体数。
total	integer (int32)	作业所针对的实体总数。

PropertyJobData

Object

属性作业数据定义。

名称	类型	说明
path	string	设备模板中目标功能的路径。
target	string minLength: 1	定义作业的目标功能的设备模板。
type	string: property	作业数据的类型。
value	AnyValue	用于更新目标功能（如果有）的值。