REST Resource: customer.devices.chromeos.commands

Zasób: DirectoryChromeosdevicesCommand

Informacje o poleceniu wydanym urządzeniu.

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.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
state

enum (State)

Wskazuje stan polecenia.
commandExpireTime

string (Timestamp format)

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

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
commandResult

object (DirectoryChromeosdevicesCommandResult)

Wynik wykonania polecenia.
payload

string

Ładunek określony przez polecenie (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 Uruchom ponownie urządzenie. Można je wydawać na urządzenia działające w trybie kiosku i zarządzanej sesji gościa oraz na zwykłe urządzenia z ChromeOS w wersji 113 lub nowszej.
TAKE_A_SCREENSHOT Zrób zrzut ekranu urządzenia. Dostępne tylko wtedy, gdy urządzenie jest w trybie kiosku.
SET_VOLUME Ustaw głośność urządzenia. Można je wydawać tylko na urządzenia kiosku i urządzenia z zarządzaną sesją gościa.
WIPE_USERS Wyczyść dane wszystkich użytkowników z urządzenia. Wykonanie tego polecenia na urządzeniu spowoduje usunięcie wszystkich danych z profili użytkowników, ale zachowa zasady dotyczące urządzeń i rejestrację.
REMOTE_POWERWASH Czyści urządzenie przez wykonanie power wash. Wykonanie tego polecenia na urządzeniu spowoduje usunięcie wszystkich danych, w tym zasad 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ą. Zachowaj ostrożność, ponieważ tej czynności nie można cofnąć.
DEVICE_START_CRD_SESSION Rozpoczyna sesję Pulpitu zdalnego Chrome.
CAPTURE_LOGS Zapisz dzienniki systemowe urządzenia kiosku. Dzienniki można pobrać z linku downloadUrl w polu deviceFiles zasobu chromeosdevices.
FETCH_CRD_AVAILABILITY_INFO Pobiera dostępne typy sesji Pulpitu zdalnego Chrome (prywatne lub udostępnione), których można użyć do zdalnego połączenia się z urządzeniem.
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ć z linku downloadURL w polu deviceFiles elementu chromeosdevices.

Stan

Reprezentuje stan wydanego polecenia.

Wartości w polu enum
STATE_UNSPECIFIED Stan polecenia jest nieokreślony.
PENDING Nieprzeterminowane polecenie, które nie zostało jeszcze wysłane do klienta.
EXPIRED Klient nie wykonał polecenia w oczekiwanym czasie.
CANCELLED Polecenie zostało anulowane przez administratora w stanie OCZEKUJE.
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)pomyślnie.

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 jego niepowodzenia.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
errorMessage

string

Komunikat o błędzie z krótkim wyjaśnieniem, dlaczego polecenie się nie powiodło. Występuje tylko wtedy, gdy polecenie się nie powiodło.
commandResultPayload

string

Ładunek wyniku polecenia. Te polecenia zwracają ładunek:

  • DEVICE_START_CRD_SESSION: ładunek to ciąg znaków obiektu JSON w formacie: { "url": url }. Podany adres URL prowadzi do sesji Pulpitu zdalnego Chrome i wymaga uwierzytelnienia przy użyciu tylko email powiązanego z wydaniem polecenia.
  • FETCH_CRD_AVAILABILITY_INFO: ładunek to ciąg znaków obiektu JSON w formacie: { "deviceIdleTimeInSeconds": number, "userSessionType": string, "remoteSupportAvailability": string, "remoteAccessAvailability": string }. Pole "remoteSupportAvailability" ma wartość "AVAILABLE", jeśli shared sesja CRD na urządzeniu jest dostępna. Pole „remoteAccessAvailability” ma wartość „AVAILABLE”, jeśli private sesja CRD na urządzeniu jest dostępna.

CommandResultType

Typ wyniku polecenia.

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

Metody

get

 Pobiera dane polecenia wydanego na urządzeniu.