REST Resource: customer.devices.chromeos.commands

资源：DirectoryChromeosdevicesCommand

有关向设备发出的命令的信息。

JSON 表示法 
{
  "commandId": string,
  "type": enum (CommandType),
  "issueTime": string,
  "state": enum (State),
  "commandExpireTime": string,
  "commandResult": {
    object (DirectoryChromeosdevicesCommandResult)
  },
  "payload": string
}
字段
commandId

string (int64 format)

设备命令的唯一 ID。
type

enum (CommandType)

命令的类型。
issueTime

string (Timestamp format)

管理员发出命令时的时间戳。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
state

enum (State)

表示命令状态。
commandExpireTime

string (Timestamp format)

命令的过期时间。如果设备未在此时间内执行命令，该命令将过期。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
commandResult

object (DirectoryChromeosdevicesCommandResult)

命令执行结果。
payload

string

相应命令指定的载荷（如果有）。

CommandType

确定设备必须执行的命令类型。

枚举
COMMAND_TYPE_UNSPECIFIED 未指定命令类型。
REBOOT 重新启动设备。可向自助服务终端设备、受管理的访客会话设备以及运行 ChromeOS 113 或更高版本的常规设备颁发。
TAKE_A_SCREENSHOT 截取设备的屏幕截图。仅当设备处于自助服务终端模式时才可用。
SET_VOLUME 设置设备的音量。只能向自助服务终端和受管理的访客会话设备颁发。
WIPE_USERS 从设备中擦除所有用户。在设备中执行此命令将移除所有用户个人资料数据，但会保留设备政策和注册数据。
REMOTE_POWERWASH 通过执行 Powerwash 来擦除设备。在设备中执行此命令会移除所有数据，包括用户政策、设备政策和注册政策。警告：这会将设备还原为未注册的出厂状态，不过启用了强制或自动注册的设备除外。请谨慎使用，因为此操作无法撤消！
DEVICE_START_CRD_SESSION 启动 Chrome 远程桌面会话。
CAPTURE_LOGS 捕获自助服务终端设备的系统日志。您可以从 chromeosdevices 的 deviceFiles 字段中提供的 downloadUrl 链接下载日志
FETCH_CRD_AVAILABILITY_INFO 获取可用于远程连接到设备的 Chrome 远程桌面会话的可用类型（不公开或共享）。
FETCH_SUPPORT_PACKET 从设备远程提取支持包。支持包是一个 ZIP 归档文件，其中包含 ChromeOS 设备的各种系统日志和调试数据。支持包可从 chromeosdevices 的 deviceFiles 字段中提供的 download网址 链接下载

州

表示已发出命令的状态。

枚举
STATE_UNSPECIFIED 未指定命令状态。
PENDING 尚未发送给客户端的未过期命令。
EXPIRED 客户端未在预期时间内执行该命令。
CANCELLED 管理员在命令处于 PENDING 状态时取消了该命令。
SENT_TO_CLIENT 命令已发送到客户端。
ACKED_BY_CLIENT 客户端已回复，表明已收到该命令。
EXECUTED_BY_CLIENT 客户端已成功/未成功执行命令。

DirectoryChromeosdevicesCommandResult

执行命令的结果。

JSON 表示法 
{
  "result": enum (CommandResultType),
  "executeTime": string,
  "errorMessage": string,
  "commandResultPayload": string
}
字段
result

enum (CommandResultType)

命令的结果。
executeTime

string (Timestamp format)

命令执行或未能执行的时间。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
errorMessage

string

包含简短说明的错误消息，说明命令失败的原因。仅当命令失败时才存在。
commandResultPayload

string

命令结果的载荷。以下命令会返回载荷：

  • DEVICE_START_CRD_SESSION：载荷是一个字符串化的 JSON 对象，格式为：{ "url": url }。提供的网址指向 Chrome 远程桌面会话，并且仅需要使用与命令发布相关联的 email 进行身份验证。
  • FETCH_CRD_AVAILABILITY_INFO：载荷是一个字符串化的 JSON 对象，格式如下：{ "deviceIdleTimeInSeconds": number, "userSessionType": string, "remoteSupportAvailability": string, "remoteAccessAvailability": string }。“remoteSupportAvailability”字段在以下情况下设置为“AVAILABLE”：shared 与设备的 CRD 会话可用。如果可以建立到设备的 private CRD 会话，“remoteAccessAvailability”字段会设置为“AVAILABLE”。

CommandResultType

命令结果的类型。

枚举
COMMAND_RESULT_TYPE_UNSPECIFIED 命令结果未指定。
IGNORED 该命令因已过时而被忽略。
FAILURE 命令未能成功执行。
SUCCESS 命令已成功执行。

方法

get

 获取向设备发出的特定命令的命令数据。