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)

Уникальный идентификатор команды устройства.

type

enum ( CommandType )

Тип команды.

issueTime

string ( Timestamp format)

Метка времени, когда администратор отдал команду.

Использует RFC 3339, согласно которому сгенерированный вывод всегда будет нормализован по оси Z и содержать 0, 3, 6 или 9 знаков после запятой. Также допускаются смещения, отличные от «Z». Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

state

enum ( State )

Указывает состояние команды.

commandExpireTime

string ( Timestamp format)

Время, по истечении которого команда истечёт. Если устройство не выполнит команду в течение этого времени, команда станет недействительной.

Использует RFC 3339, согласно которому сгенерированный вывод всегда будет нормализован по оси Z и содержать 0, 3, 6 или 9 знаков после запятой. Также допускаются смещения, отличные от «Z». Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

commandResult

object ( DirectoryChromeosdevicesCommandResult )

Результат выполнения команды.

payload

string

Полезная нагрузка, указанная в команде, если таковая имеется.

CommandType

Устанавливает тип команды, которую должно выполнить устройство.

Перечисления
COMMAND_TYPE_UNSPECIFIED Тип команды не указан.
REBOOT Перезагрузите устройство. Может быть выдан на устройствах с режимом киоска и управляемыми гостевыми сеансами, а также на обычных устройствах под управлением ChromeOS версии 113 или более поздней.
TAKE_A_SCREENSHOT Сделайте снимок экрана устройства. Доступно только в режиме киоска.
SET_VOLUME Установите громкость устройства. Доступно только для устройств в режиме киоска и управляемых гостевых сеансов.
WIPE_USERS Удалите данные всех пользователей с устройства. Выполнение этой команды на устройстве удалит все данные профилей пользователей, но сохранит политику устройства и регистрацию.
REMOTE_POWERWASH Очищает устройство посредством Power Wash. Выполнение этой команды на устройстве удалит все данные, включая политики пользователя, политики устройства и политики регистрации. Внимание: это вернет устройство к заводскому состоянию без регистрации, если только устройство не было зарегистрировано принудительно или автоматически. Используйте с осторожностью, так как это необратимое действие!
DEVICE_START_CRD_SESSION Запускает сеанс удаленного рабочего стола Chrome.
CAPTURE_LOGS Сохраните системные журналы устройства-киоска. Журналы можно скачать по ссылке downloadUrl в поле deviceFiles в Chromeosdevices.
FETCH_CRD_AVAILABILITY_INFO Извлекает доступные типы сеансов удаленного рабочего стола Chrome (частные или общие), которые можно использовать для удаленного подключения к устройству.
FETCH_SUPPORT_PACKET Удалённое получение пакета поддержки с устройства. Пакет поддержки — это ZIP-архив, содержащий различные системные журналы и отладочные данные с устройства ChromeOS. Пакет поддержки можно загрузить по ссылке downloadURL, указанной в поле deviceFiles на сайте chromeosdevices

Состояние

Представляет состояние выданной команды.

Перечисления
STATE_UNSPECIFIED Статус команды не указан.
PENDING Действующая команда, еще не отправленная клиенту.
EXPIRED Команда не была выполнена клиентом в ожидаемое время.
CANCELLED Команда отменена администратором в состоянии ОЖИДАНИЯ.
SENT_TO_CLIENT Команда отправлена ​​клиенту.
ACKED_BY_CLIENT Клиент ответил, что получил команду.
EXECUTED_BY_CLIENT Клиент (не)успешно выполнил команду.

КаталогChromeosdevicesCommandResult

Результат выполнения команды.

JSON-представление 
{
  "result": enum (CommandResultType),
  "executeTime": string,
  "errorMessage": string,
  "commandResultPayload": string
}
Поля
result

enum ( CommandResultType )

Результат команды.

executeTime

string ( Timestamp format)

Время выполнения или невыполнения команды.

Использует RFC 3339, согласно которому сгенерированный вывод всегда будет нормализован по оси Z и содержать 0, 3, 6 или 9 знаков после запятой. Также допускаются смещения, отличные от «Z». Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

errorMessage

string

Сообщение об ошибке с кратким объяснением причины сбоя команды. Отображается только в случае сбоя команды.

commandResultPayload

string

Полезная нагрузка для результата команды. Следующие команды возвращают полезную нагрузку:

  • DEVICE_START_CRD_SESSION : Полезная нагрузка представляет собой строковый JSON-объект в формате: { "url": url }. Предоставленный URL-адрес ведет к сеансу удалённого рабочего стола Chrome и требует аутентификации только с использованием email связанного с выполнением команды.
  • FETCH_CRD_AVAILABILITY_INFO : Полезная нагрузка представляет собой строковый объект JSON в формате: { "deviceIdleTimeInSeconds": number, "userSessionType": string, "remoteSupportAvailability": string, "remoteAccessAvailability": string}. Поле "remoteSupportAvailability" имеет значение "AVAILABLE", если доступен shared сеанс CRD с устройством. Поле "remoteAccessAvailability" имеет значение "AVAILABLE", если доступен private сеанс CRD с устройством.

CommandResultType

Тип результата команды.

Перечисления
COMMAND_RESULT_TYPE_UNSPECIFIED Результат команды не указан.
IGNORED Команда была проигнорирована как устаревшая.
FAILURE Команда не может быть выполнена успешно.
SUCCESS Команда была успешно выполнена.

Методы

get

 Получает данные команды, определенной команды, выданной устройству.