REST Resource: customer.devices.chromeos.commands

Zasób: DirectoryChromeosdevicesCommand

Informacje dotyczące 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 urządzenia.

type

enum (CommandType)

Typ polecenia.

issueTime

string (Timestamp format)

Sygnatura czasowa wydania polecenia przez administratora.

Sygnatura czasowa w formacie „Zulu” RFC3339 UTC z rozdzielczością nanosekundową 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 w tym czasie urządzenie nie wykona polecenia, wygaśnie ono.

Sygnatura czasowa w formacie „Zulu” RFC3339 UTC z rozdzielczością nanosekundową 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 w poleceniu (jeśli istnieje).

CommandType

Określa typ polecenia, które urządzenie musi wykonać.

Wartości w polu enum
COMMAND_TYPE_UNSPECIFIED Typ polecenia nie został określony.
REBOOT Zrestartuj urządzenie. Można je przydzielać tylko urządzeniom działającym w trybie kiosku i zarządzanej sesji gościa.
TAKE_A_SCREENSHOT Zrób zrzut ekranu urządzenia. Dostępna tylko wtedy, gdy urządzenie działa w trybie kiosku.
SET_VOLUME Ustaw głośność urządzenia. Można je przydzielać tylko urządzeniom działającym w trybie kiosku i 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 profili użytkowników, ale zachowanie zasad dotyczących urządzeń i rejestracji.
REMOTE_POWERWASH Wymazuje urządzenie, wykonując Power wash. Wykonanie tego polecenia na urządzeniu spowoduje usunięcie wszystkich danych, w tym zasad dotyczących użytkowników oraz zasad dotyczących urządzeń i 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ą. Zachowaj ostrożność, 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. Dzienniki można pobrać, klikając link downloadUrl w polu deviceFiles na urządzeniach chromeosdevices.
FETCH_SUPPORT_PACKET Zdalne pobieranie pakietu pomocy z urządzenia. Pakiet pomocy to archiwum ZIP zawierające różne dzienniki systemowe i dane debugowania z urządzenia z ChromeOS. Pakiet pomocy można pobrać, klikając link downloadURL w polu deviceFiles w chromeosdevices.

Stan

Reprezentuje stan wydanego polecenia.

Wartości w polu enum
STATE_UNSPECIFIED Stan polecenia był nieokreślony.
PENDING Aktualne 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ĄCE.
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ę go wykonać).

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)

Godzina wykonania polecenia lub tego, kiedy nie udało się go wykonać.

Sygnatura czasowa w formacie „Zulu” RFC3339 UTC z rozdzielczością nanosekundową 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, dlaczego nie udało się wykonać polecenia. Widoczny tylko w przypadku niepowodzenia polecenia.

commandResultPayload

string

Ładunek wyniku polecenia. W odpowiedzi na te polecenia wysyła ładunek:

  • DEVICE_START_CRD_SESSION: ładunek jest obiektem JSON z ciągami znaków i ma postać: { "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 był 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 za pomocą określonego polecenia wydanego na urządzenie.