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

enum (State)

表示指令狀態。
commandExpireTime

string (Timestamp format)

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

RFC3339 UTC 的「Zulu」格式的時間戳記，單位為奈秒解析度，最多可達 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
commandResult

object (DirectoryChromeosdevicesCommandResult)

指令執行的結果。
payload

string

指令指定的酬載 (如果有的話)。

CommandType

建立裝置必須執行的指令類型。

列舉
COMMAND_TYPE_UNSPECIFIED 未指定指令類型。
REBOOT 重新啟動裝置。只能核發給資訊站和受管理的訪客工作階段裝置。
TAKE_A_SCREENSHOT 擷取裝置的螢幕截圖。裝置必須處於 Kiosk 模式才能使用。
SET_VOLUME 設定裝置音量。只能核發給資訊站和受管理的訪客工作階段裝置。
WIPE_USERS 清除裝置上的所有使用者。在裝置上執行這個指令會移除所有使用者個人資料，但會保留裝置政策和註冊資料。
REMOTE_POWERWASH 執行 Powerwash 以清除裝置資料。在裝置中執行這個指令會移除所有資料，包括使用者政策、裝置政策和註冊政策。警告：這項操作會將裝置還原為未註冊的原廠狀態，除非裝置必須強製或自動註冊。請小心使用，因為此動作無法復原。
DEVICE_START_CRD_SESSION 啟動 Chrome 遠端桌面工作階段。
CAPTURE_LOGS 擷取資訊站裝置的系統記錄。您可以前往電腦裝置「deviceFiles」欄位中的 DownloadUrl 連結下載記錄

狀態

代表已發出指令的狀態。

列舉
STATE_UNSPECIFIED 未指定指令狀態。
PENDING 尚未傳送至用戶端的未過期指令。
EXPIRED 該指令並未在預期的時間內執行。
CANCELLED 管理員在 PENDING 時已取消這個指令。
SENT_TO_CLIENT 該指令已傳送至用戶端。
ACKED_BY_CLIENT 用戶端已回應已收到指令。
EXECUTED_BY_CLIENT 用戶端 (un) 成功執行指令。

DirectoryChromeosdevicesCommand 結果

執行指令的結果。

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

enum (CommandResultType)

指令執行的結果。
executeTime

string (Timestamp format)

執行或無法執行指令的時間。

RFC3339 UTC 的「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

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