REST Resource: customer.devices.chromeos.commands

Zasób: DirectoryChromeosdevicesCommand

Informacje na temat polecenia wydanego na urządzenie.

Zapis JSON 
{
  "commandId": string,
  "type": enum (CommandType),
  "issueTime": string,
  "state": enum (State),
  "commandExpireTime": string,
  "commandResult": {
    object (DirectoryChromeosdevicesCommandResult)
  },
  "payload": string
}
Pola
commandId

string (int64 format)

Unikalny identyfikator polecenia na urządzeniu.
type

enum (CommandType)

Typ polecenia.
issueTime

string (Timestamp format)

Sygnatura czasowa wydania polecenia przez administratora.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu” z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
state

enum (State)

Wskazuje stan polecenia.
commandExpireTime

string (Timestamp format)

Godzina wygaśnięcia polecenia. Jeśli urządzenie nie uruchomi polecenia w tym czasie, wygaśnie ono.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu” z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
commandResult

object (DirectoryChromeosdevicesCommandResult)

Wynik wykonania polecenia.
payload

string

Ładunek określony przez polecenie (jeśli taki istnieje).

CommandType

Ustanawia typ polecenia, które musi wykonać urządzenie.

Wartości w polu enum
COMMAND_TYPE_UNSPECIFIED Typ polecenia był nieokreślony.
REBOOT Zrestartuj urządzenie. Może być przyznawana na urządzeniach kiosku i w zarządzanej sesji gościa, a także na zwykłych urządzeniach z ChromeOS w wersji 113 lub nowszej.
TAKE_A_SCREENSHOT Zrób zrzut ekranu urządzenia. Ta opcja jest dostępna tylko wtedy, gdy urządzenie jest w trybie kiosku.
SET_VOLUME Ustawia głośność urządzenia. Jest przyznawana tylko na urządzeniach w trybie kiosku i w zarządzanej sesji gościa.
WIPE_USERS Usuń wszystkich użytkowników z urządzenia. Wykonanie tego polecenia na urządzeniu spowoduje usunięcie wszystkich danych profilu użytkownika, ale zachowanie zasad dotyczących urządzeń i rejestracji zostanie zachowane.
REMOTE_POWERWASH Czyści pamięć urządzenia, wykonując Power wash. Wykonanie tego polecenia na urządzeniu spowoduje usunięcie wszystkich danych, w tym zasad dotyczących użytkowników, zasad dotyczących urządzeń i zasad rejestracji. Ostrzeżenie: spowoduje to przywrócenie na urządzeniu ustawień fabrycznych – nie będzie ono zarejestrowane, chyba że jest objęte wymuszoną lub automatyczną rejestracją. Korzystaj z tej opcji ostrożnie, ponieważ tej czynności nie można cofnąć.
DEVICE_START_CRD_SESSION Rozpoczyna sesję Pulpitu zdalnego Chrome.
CAPTURE_LOGS Przechwytywanie dzienników systemowych urządzenia kiosku. Logi można pobrać, korzystając z linku downloadUrl znajdującego się w polu deviceFiles na chromeosdevices
FETCH_SUPPORT_PACKET Pobierz zdalnie pakiet pomocy z urządzenia. Pakiet pomocy to archiwum ZIP, które zawiera różne dzienniki systemowe i dane debugowania z urządzenia z ChromeOS. Pakiet pomocy można pobrać, klikając link downloadURL znajdujący się w polu deviceFiles chromeosdevices.

Stan

Reprezentuje stan wydanego polecenia.

Wartości w polu enum
STATE_UNSPECIFIED Stan polecenia był nieokreślony.
PENDING Wygasłe polecenie, które nie zostało jeszcze wysłane do klienta.
EXPIRED Polecenie nie zostało wykonane przez klienta w oczekiwanym czasie.
CANCELLED Polecenie zostało anulowane przez administratora w trybie OCZEKUJĄCA.
SENT_TO_CLIENT Polecenie zostało wysłane do klienta.
ACKED_BY_CLIENT Klient odpowiedział, że otrzymał polecenie.
EXECUTED_BY_CLIENT Klient wykonał polecenie (nie udało się).

DirectoryChromeosdevicesCommandResult

Wynik wykonania polecenia.

Zapis JSON 
{
  "result": enum (CommandResultType),
  "executeTime": string,
  "errorMessage": string,
  "commandResultPayload": string
}
Pola
result

enum (CommandResultType)

Wynik polecenia.
executeTime

string (Timestamp format)

Czas wykonania polecenia lub nie udało się go wykonać.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu” z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
errorMessage

string

Komunikat o błędzie z krótkim wyjaśnieniem przyczyny niepowodzenia wykonania polecenia. Widoczny tylko wtedy, gdy polecenie nie zostało wykonane.
commandResultPayload

string

Ładunek wyniku polecenia. Te polecenia odpowiadają ładunkowi:

  • DEVICE_START_CRD_SESSION: ładunek to obiekt JSON o formie ciągu znaków w formacie { "url": url }. Adres URL zawiera link do sesji Pulpitu zdalnego Chrome.

CommandResultType

Typ wyniku polecenia.

Wartości w polu enum
COMMAND_RESULT_TYPE_UNSPECIFIED Wynik polecenia jest nieokreślony.
IGNORED Polecenie zostało zignorowane jako nieaktualne.
FAILURE Nie udało się wykonać polecenia.
SUCCESS Polecenie zostało wykonane.

Metody

get

 Pobiera dane polecenia wydane dla urządzenia.