通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Jobs - Get Scheduled Job

  • 参考
服务:
IoT Hub
API 版本:
2021-04-12

从 IoT 中心获取计划作业的详细信息。 有关详细信息，请参阅 https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs。

GET https://fully-qualified-iothubname.azure-devices.net/jobs/v2/{id}?api-version=2021-04-12

URI 参数

名称 在 必需 类型 说明
id
 path True

string

作业的唯一标识符。
api-version
 query True

string

Api 的版本。

响应

名称 类型 说明
200 OK

JobResponse

还行。

定义

名称 说明
CloudToDeviceMethod

用于在设备上执行直接方法的参数。
DeviceCapabilities

设备上启用的功能的状态。
DeviceJobStatistics

有关执行状态的作业统计信息。
JobResponse
Twin

设备或模块的状态信息。 在 IoT 中心创建或删除相应的设备/模块标识时，会隐式创建和删除此标识。
TwinProperties

孪生体的所需属性和报告属性。 对象的最大深度为 10。
X509Thumbprint

CloudToDeviceMethod

Object

用于在设备上执行直接方法的参数。

名称 类型 说明
connectTimeoutInSeconds

integer (int32)

methodName

string

要执行的方法的名称。
payload

object

JSON 格式的直接方法有效负载，最大大小为 128kb。
responseTimeoutInSeconds

integer (int32)

DeviceCapabilities

Object

设备上启用的功能的状态。

名称 类型 说明
iotEdge

boolean

确定设备是否为边缘设备的属性。

DeviceJobStatistics

Object

有关执行状态的作业统计信息。

名称 类型 说明
deviceCount

integer (int32)

作业的目标设备数。
failedCount

integer (int32)

失败的作业数。
pendingCount

integer (int32)

挂起的（已计划）作业数。
runningCount

integer (int32)

正在运行的作业数。
succeededCount

integer (int32)

成功的作业数。

JobResponse

Object
名称 类型 说明
cloudToDeviceMethod

CloudToDeviceMethod

方法类型和参数。 如果作业类型为 cloudToDeviceMethod，则需要此作。
createdTime

string (date-time)

系统生成。 创建时忽略。 作业的创建日期和时间。
deviceJobStatistics

DeviceJobStatistics

有关作业执行状态的详细信息。
endTime

string (date-time)

系统生成。 创建时忽略。 作业的结束日期和时间（UTC）。
failureReason

string

失败的原因（如果发生故障）。
jobId

string

系统生成。 创建时忽略。 作业的唯一标识符。
maxExecutionTimeInSeconds

integer (int64)

最大执行时间（以秒为单位）。
queryCondition

string

设备查询条件。
startTime

string (date-time)

计划作业的开始日期和时间（UTC）。
status enum:
  • cancelled
  • completed
  • enqueued
  • failed
  • queued
  • running
  • scheduled
  • unknown

系统生成。 创建时忽略。 作业的状态。
statusMessage

string

作业的状态消息。
type enum:
  • backup
  • export
  • factoryResetDevice
  • failoverDataCopy
  • firmwareUpdate
  • import
  • readDeviceProperties
  • rebootDevice
  • restoreFromBackup
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • unknown
  • updateDeviceConfiguration
  • writeDeviceProperties

作业类型。
updateTwin

Twin

设备或模块的状态信息。 在 IoT 中心创建或删除相应的设备/模块标识时，会隐式创建和删除此标识。

Twin

Object

设备或模块的状态信息。 在 IoT 中心创建或删除相应的设备/模块标识时，会隐式创建和删除此标识。

名称 类型 说明
authenticationType enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

设备使用的身份验证类型。
capabilities

DeviceCapabilities

设备上启用的功能的状态。
cloudToDeviceMessageCount

integer (int32)

发送的云到设备的消息数。
connectionState enum:
  • Connected
  • Disconnected

设备的连接状态。
deviceEtag

string

根据RFC7232表示设备的 ETag 的字符串。
deviceId

string

IoT 中心的标识注册表中设备的唯一标识符。 它是 ASCII 7 位字母数字字符的区分大小写的字符串（最长为 128 个字符）， 和以下特殊字符 {'-'，'：'，'.'，'+'，'%'， '_'， '#'， '*'， '？'， '！'， '（'，'）'，'='，'@'， ';，'$'， ''''}。
deviceScope

string

设备的范围。
etag

string

根据RFC7232表示设备孪生的 ETag 的字符串。
lastActivityTime

string (date-time)

设备上次连接或接收或发送消息的日期和时间。 日期和时间以 UTC 格式ISO8601日期/时间格式进行分隔，例如 2015-01-28T16：24：48.789Z。 如果设备使用 HTTP/1 协议执行消息传送作，则不会更新此值。
moduleId

string

IoT 中心的标识注册表中模块的唯一标识符。 它是 ASCII 7 位字母数字字符的区分大小写的字符串（最长为 128 个字符）， 和以下特殊字符 {'-'，'：'，'.'，'+'，'%'， '_'， '#'， '*'， '？'， '！'， '（'，'）'，'='，'@'， ';，'$'， ''''}。
parentScopes

string[]

上层边缘设备的作用域（如果适用）。 仅适用于边缘设备。
properties

TwinProperties

孪生体的所需属性和报告属性。
status enum:
  • disabled
  • enabled

设备的启用状态。 如果禁用，设备无法连接到服务。
statusReason

string

设备的当前状态（如果有）的原因。
statusUpdateTime

string (date-time)

上次更新设备状态的日期和时间。
tags

object

由解决方案后端读取和写入的键值对的集合。 设备应用看不到它们。 它们键的长度为 UTF-8 编码、区分大小写和 up-to 1KB。 允许的字符不包括 UNICODE 控制字符（段 C0 和 C1）、“.”、“$”和空格。 这些值为 JSON 对象，长度 up-to 4KB。
version

integer (int64)

设备孪生的版本，包括标记和所需属性
x509Thumbprint

X509Thumbprint

设备的 X509 指纹。

TwinProperties

Object

孪生体的所需属性和报告属性。 对象的最大深度为 10。

名称 类型 说明
desired

object

所需属性键值对的集合。 密钥的长度为 UTF-8 编码、区分大小写和 up-to 1KB。 允许的字符不包括 UNICODE 控制字符（段 C0 和 C1）、“.”、“$”和空格。 所需的门廊值是 JSON 对象，up-to 长度为 4KB。
reported

object

报告的属性键值对的集合。 密钥的长度为 UTF-8 编码、区分大小写和 up-to 1KB。 允许的字符不包括 UNICODE 控制字符（段 C0 和 C1）、“.”、“$”和空格。 报告的属性值是 JSON 对象，up-to 长度为 4KB。

X509Thumbprint

Object
名称 类型 说明
primaryThumbprint

string

X509 客户端证书主指纹。
secondaryThumbprint

string

X509 客户端证书辅助指纹。