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 世界標準時間「Zulu」的時間戳記格式，解析度不超過奈秒，最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
state

enum (State)

指出指令狀態。
commandExpireTime

string (Timestamp format)

指令的到期時間。如果裝置未在這段時間內執行指令，指令就會失效。

RFC3339 世界標準時間「Zulu」的時間戳記格式，解析度不超過奈秒，最多 9 個小數位數。範例："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 擷取裝置的螢幕截圖。只有在裝置處於 Kiosk 模式時才能使用。
SET_VOLUME 設定裝置音量。只能核發給資訊站和受管理的訪客工作階段裝置。
WIPE_USERS 抹除裝置的所有使用者。在裝置上執行這個指令後，系統將移除所有使用者設定檔資料，但會保留裝置政策和註冊資料。
REMOTE_POWERWASH 執行 Powerwash 抹除裝置資料。如果在裝置中執行這個指令，系統將移除所有資料，包括使用者政策、裝置政策和註冊政策。警告：這項操作會將裝置還原為未註冊的原廠狀態，除非裝置採用強製或自動註冊模式。這項操作無法復原，請謹慎使用！
DEVICE_START_CRD_SESSION 啟動 Chrome 遠端桌面工作階段。
CAPTURE_LOGS 擷取資訊站裝置的系統記錄。您可以從 chromeosdevices 的 deviceFiles 欄位中找到 downloadUrl 連結，下載記錄。
FETCH_SUPPORT_PACKET 從遠端擷取裝置的支援封包。「支援封包」是一個 ZIP 封存檔，內含 ChromeOS 裝置的各種系統記錄和偵錯資料。您可以從 chromeosdevices deviceFiles 欄位中的 downloadURL 連結下載支援封包

州

代表發出指令的狀態。

列舉
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 世界標準時間「Zulu」的時間戳記格式，解析度不超過奈秒，最多 9 個小數位數。範例："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

 取得核發給裝置的特定指令資料。