Jobs - Get Devices

服务:

IoT Central

API 版本:

2022-07-31

获取设备状态
按作业 ID 获取单个设备状态的列表。

GET https://{subdomain}.{baseDomain}/api/jobs/{jobId}/devices?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	JobDeviceStatusCollection	成功
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 device statuses

示例请求

HTTP

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

示例响应

状态代码:

200

{
  "value": [
    {
      "id": "ylleedih6k",
      "status": "completed"
    },
    {
      "id": "t81v3k204k",
      "status": "completed"
    },
    {
      "id": "iotc-1",
      "status": "completed"
    },
    {
      "id": "iotc",
      "status": "completed"
    },
    {
      "id": "1c5cs18m7k1",
      "status": "completed"
    }
  ]
}

定义

名称	说明
Error	响应错误定义。
ErrorDetails	错误的详细信息。
JobDeviceStatus	作业设备状态定义。
JobDeviceStatusCollection	作业设备状态的分页结果。

Error

Object

响应错误定义。

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

ErrorDetails

Object

错误的详细信息。

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

JobDeviceStatus

Object

作业设备状态定义。

名称	类型	说明
id	string	正在提供作业状态的设备 ID。
status	string	指示作业是否正在为给定设备启动、运行等。

JobDeviceStatusCollection

Object

作业设备状态的分页结果。

名称	类型	说明
nextLink	string	用于获取作业设备状态的下一页的 URL。
value	JobDeviceStatus[]	作业设备状态的集合。