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 擷取裝置的螢幕截圖。僅適用於處於 Kiosk 模式的裝置。
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 欄位中的 downloadURL 連結下載支援封包

州

代表已發出的指令狀態。

列舉
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

 取得指令資料，該資料是指向裝置的特定指令。