REST Resource: customer.devices.chromeos.commands

Zasób: DirectoryChromeosdevicesCommand

Informacje o poleceniu wysłanym do urządzenia.

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, kiedy polecenie zostało wydane przez administratora.

Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Dopuszczalne 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, w którym polecenie wygaśnie. Jeśli urządzenie nie wykona polecenia w tym czasie, polecenie wygaśnie.

Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Dopuszczalne 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

Dane ładunku określone przez polecenie (jeśli występują).

CommandType

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

Wartości w polu enum
COMMAND_TYPE_UNSPECIFIED Nieokreślony typ polecenia.
REBOOT Uruchom ponownie urządzenie. Można je wydawać na urządzeniach z trybem kiosku i zarządzanymi sesjami gościa oraz na zwykłych urządzeniach 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. Mogą być wydawane tylko na urządzeniach w trybie kiosku i zarządzanej sesji gościa.
WIPE_USERS Wyczyść dane wszystkich użytkowników z urządzenia. Wykonywanie tego polecenia na urządzeniu spowoduje usunięcie wszystkich danych z profilu użytkownika, ale zachowa zasady dotyczące urządzenia i stan rejestracji.
REMOTE_POWERWASH Wymazuje urządzenie, wykonując czyszczenie. Wykonywanie tego polecenia na urządzeniu powoduje 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ą. Używaj z ostrożnością, ponieważ tej czynności nie można cofnąć.
DEVICE_START_CRD_SESSION Uruchamia sesję Pulpitu zdalnego Chrome.
CAPTURE_LOGS Przechwyć dzienniki systemowe urządzenia kiosku. Dzienniki można pobrać z linku downloadUrl w polu deviceFiles w chromeosdevices.
FETCH_CRD_AVAILABILITY_INFO Pobiera informacje, które określają dostępność Pulpitu zdalnego Chrome na urządzeniu.
FETCH_SUPPORT_PACKET Pobieranie pakietu pomocy z urządzenia z dalu. Pakiet pomocy to archiwum ZIP zawierające różne dzienniki systemowe i dane debugowania z urządzenia z ChromeOS. Pakiet pomocy można pobrać, korzystając z linku downloadURL w polu deviceFiles w chromeosdevices

Stan

Reprezentuje stan wydanego polecenia.

Wartości w polu enum
STATE_UNSPECIFIED Stan polecenia jest nieokreślony.
PENDING Niewygasłe 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, gdy było w stanie OCZEKUJE.
SENT_TO_CLIENT Polecenie zostało wysłane do klienta.
ACKED_BY_CLIENT Klient potwierdził, że otrzymał polecenie.
EXECUTED_BY_CLIENT Klient wykonał (lub nie) polecenie.

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 lub niewykonania polecenia.

Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Dopuszczalne 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; Widoczny tylko wtedy, gdy polecenie nie zostało wykonane.
commandResultPayload

string

Dane użyte do wykonania polecenia. Te polecenia zwracają ładunek:

  • DEVICE_START_CRD_SESSION: Payload to zakodowany w ciągu obiekt JSON w formie: { "url": url }. Adres URL zawiera link do sesji zdalnego pulpitu Chrome.

CommandResultType

Typ wyniku polecenia.

Wartości w polu enum
COMMAND_RESULT_TYPE_UNSPECIFIED Wynik polecenia nie został okreś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, czyli konkretne polecenie wysłane do urządzenia.