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，并使用 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，并使用 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 通过执行电源清除来擦除设备。在设备上执行此命令会移除所有数据，包括用户政策、设备政策和注册政策。警告：这会将设备还原为未注册的出厂状态，不过启用了强制或自动注册的设备除外。请谨慎使用，因为此操作无法撤消！
DEVICE_START_CRD_SESSION 启动 Chrome 远程桌面会话。
CAPTURE_LOGS 捕获自助服务终端设备的系统日志。您可以通过 chromeosdevices 的 deviceFiles 字段中的 downloadUrl 链接下载日志
FETCH_CRD_AVAILABILITY_INFO 提取用于确定设备上 CRD（Chrome 远程桌面）可用性的相关信息。
FETCH_SUPPORT_PACKET 远程从设备提取支持文件包。支持包是一个 ZIP 归档文件，其中包含 ChromeOS 设备中的各种系统日志和调试数据。您可以通过 chromeosdevices 的 deviceFiles 字段中的 download网址 链接下载支持文件包

州

表示发出的命令的状态。

枚举
STATE_UNSPECIFIED 未指定命令状态。
PENDING 尚未发送到客户端的未过期命令。
EXPIRED 客户端未在预期时间内执行该命令。
CANCELLED 管理员在命令处于“待处理”状态时将其取消。
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，并使用 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 远程桌面会话的链接。

CommandResultType

命令结果的类型。

枚举
COMMAND_RESULT_TYPE_UNSPECIFIED 未指定命令结果。
IGNORED 该命令已被忽略，因为它已过时。
FAILURE 无法成功执行该命令。
SUCCESS 命令已成功执行。

方法

get

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