获取设备命令状态 (已弃用)

命名空间：microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。

获取设备上命令的状态。 有关状态代码的完整列表，请参阅 actionStatus 列表。

警告

2020 年 9 月 30 日，此 API 已弃用并停止返回数据。

此 API 可用于以下国家级云部署。

全局服务	美国政府 L4	美国政府 L5 (DOD)	由世纪互联运营的中国
✅	❌	❌	❌

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型。 要了解有关这些权限的详细信息，请参阅 权限参考。

权限类型	最低特权权限	更高特权权限
委派（工作或学校帐户）	不支持。	不支持。
委派（个人 Microsoft 帐户）	Device.Command	不可用。
应用程序	不支持。	不支持。

HTTP 请求

GET me/devices/{id}/commands/{id}

请求标头

标头	值
Authorization	持有者 {token}。 必填。 详细了解 身份验证和授权。
接受	application/json

响应

HTTP/1.1 200 OK

  {
    "id": "0",
    "status": "requesting",
    "type": "null",
    "appServiceName": "null",
    "packageFamilyName": "null",
    "error": "null",
    "responsepayload": "null",
    "payload": "null",
    "permissionTicket": "null",
    "postBackUri": "null"
  }

actionStatus 列表

• 请求，// 命令已创建，正在等待处理
• sentToTarget，// 命令已发送到目标设备
• 正在执行，// 目标设备已确认收到命令并正在执行命令
• completed、// 命令执行已完成
• failedToSend、// 服务无法将命令发送到目标设备
• executionFailed、// 命令执行失败
• commandDropped， // 如果设备处于 ConnectedStandby 状态，则客户端删除的命令
• cancel、// Cancel the command
• 正在取消、// 取消命令
• 已取消，// 命令已取消
• retry，// 服务正在重试以将命令发送到目标
• 已过期，// 命令处理已超出过期时间
• error，// 处理命令时出现内部错误
• 自定义 // 自定义状态

示例

在此示例中，需要设备的 ID 和颁发给设备的命令的 ID。 向 发出 GET 调用 /me/devices时返回设备 ID，在 上 /me/devices/{id}/command执行 POST 调用时返回命令 ID。

请求

下面为请求示例。

GET me/devices/{id}/commands/{id}
Authorization: Bearer Eaeou....
Content-Type: application/json; charset=utf-8

响应

以下示例显示了相应的响应。

HTTP/1.1 200 OK

{
  "value":
  {
    "id": "0158355AD4D680CC4E2994CC009EFFD7337D1335FCA6ED266…",
    "status": "completed",
    "type": null,
    "appServiceName": null,
    "packageFamilyName": null,
    "error": null,
    "permissionTicket": null,
    "postBackUri": null,
    "payload": null
  }
}

获取命令有效负载

获取设备上特定操作的响应有效负载。 查询应用服务以传回数据时，将使用响应有效负载。

权限

要调用此 API，需要以下权限之一。 若要了解详细信息，包括如何选择权限的信息，请参阅权限。

权限类型	权限（从最低特权到最高特权）
委派（工作或学校帐户）	不支持。
委派（个人 Microsoft 帐户）	Device.Command
应用程序	不支持。

HTTP 请求

GET me/devices/{id}/commands/{id}/responsePayload

请求标头

标头	值
Authorization	持有者 {token}。 必填。 详细了解 身份验证和授权。
接受	application/json

响应

HTTP/1.1 200 OK

{
  "@odata.context": "https://graph.microsoft.com/devices/$metadata#microsoft.graph.PayloadResponse",
  "MsIgnoredParameter":0,
  "CreationDate":"date-time",
  "Type":"Ok"
}

示例

在此示例中，需要设备的 ID 和颁发给设备的命令的 ID。 在 上 /me/devices发出 GET 调用时返回设备 ID，在 上 /me/devices/{id}/command执行 POST 调用时返回命令 ID。

请求

下面为请求示例。

GET me/devices/{id}/commands/{id}
Authorization: Bearer Eaeou....
Content-Type: application/json; charset=utf-8

响应

以下示例显示了相应的响应。

HTTP/1.1 200 OK

{
  "@odata.context": "https://graph.microsoft.com/devices/$metadata#microsoft.graph.PayloadResponse",
  "MsIgnoredParameter":0,
  "CreationDate":"04/27/2017",
  "Type":"Ok"
}