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)

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

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
state

enum (State)

指示命令状态。
commandExpireTime

string (Timestamp format)

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

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
commandResult

object (DirectoryChromeosdevicesCommandResult)

命令执行的结果。
payload

string

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

CommandType

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

枚举
COMMAND_TYPE_UNSPECIFIED 未指定命令类型。
REBOOT 重新启动设备。可发布至自助服务终端设备、受管理的访客会话设备，以及运行 ChromeOS 113 或更高版本的常规设备。
TAKE_A_SCREENSHOT 截取设备的屏幕截图。仅在设备处于自助服务终端模式时才可用。
SET_VOLUME 设置设备的音量。只能发送给自助服务终端设备和受管理的访客会话设备。
WIPE_USERS 擦除设备上的所有用户。在设备上执行此命令会移除所有用户个人资料数据，但会保留设备政策和注册信息。
REMOTE_POWERWASH 通过执行 Power wash 来擦除设备。在设备中执行此命令将移除所有数据，包括用户政策、设备政策和注册政策。警告：此操作会将设备还原为未注册的出厂状态，除非设备被强制或自动注册。请谨慎操作，因为此操作无法撤消！
DEVICE_START_CRD_SESSION 启动 Chrome 远程桌面会话。
CAPTURE_LOGS 获取自助服务终端设备的系统日志。您可以通过 chromeosdevices 的 deviceFiles 字段中提供的 downloadUrl 链接下载这些日志
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)

命令的执行时间或执行失败的时间。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
errorMessage

string

错误消息，简要说明命令失败的原因。仅在命令失败时显示。
commandResultPayload

string

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

  • DEVICE_START_CRD_SESSION：载荷是一个字符串化的 JSON 对象，格式为：{ "url": url }。该网址提供了 Chrome 远程桌面会话的链接。

CommandResultType

命令结果的类型。

枚举
COMMAND_RESULT_TYPE_UNSPECIFIED 未指定命令结果。
IGNORED 该命令已作废，因此已被忽略。
FAILURE 无法成功执行该命令。
SUCCESS 已成功执行该命令。

方法

get

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