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)

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

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

state

enum ( State )

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

commandExpireTime

string ( Timestamp format)

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

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

commandResult

object ( DirectoryChromeosdevicesCommandResult )

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

payload

string

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

ТипКоманды

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

Перечисления
COMMAND_TYPE_UNSPECIFIED Тип команды не указан.
REBOOT Перезагрузите устройство. Может быть выдана киоск-устройствам и устройствам управляемого гостевого сеанса, а также обычным устройствам под управлением ChromeOS версии 113 или более поздней.
TAKE_A_SCREENSHOT Сделайте скриншот устройства. Доступно только в том случае, если устройство находится в режиме киоска.
SET_VOLUME Установите громкость устройства. Может быть выдано только киоскам и устройствам управляемого гостевого сеанса.
WIPE_USERS Удалите всех пользователей с устройства. Выполнение этой команды на устройстве приведет к удалению всех данных профиля пользователя, но сохранит политику устройства и регистрацию.
REMOTE_POWERWASH Очищает устройство, выполняя мощную промывку. Выполнение этой команды на устройстве приведет к удалению всех данных, включая политики пользователей, политики устройств и политики регистрации. Предупреждение. Это вернет устройство обратно в заводское состояние без регистрации, если только устройство не подлежит принудительной или автоматической регистрации. Используйте с осторожностью, так как это необратимое действие!
DEVICE_START_CRD_SESSION Запускает сеанс удаленного рабочего стола Chrome.
CAPTURE_LOGS Запишите системные журналы киоск-устройства. Журналы можно загрузить по ссылке downloadUrl, присутствующей в поле deviceFiles файла chromeosdevices.
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)

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

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

errorMessage

string

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

commandResultPayload

string

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

  • DEVICE_START_CRD_SESSION : Полезная нагрузка представляет собой строковый объект JSON в форме: { "url": url }. URL-адрес предоставляет ссылку на сеанс удаленного рабочего стола Chrome.

ТипКомандыРезультата

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

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

Методы

get

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