REST Resource: chromeosdevices

Ресурс: ChromeOsDevice

Устройства Google Chrome работают под управлением Chrome OS . Дополнительную информацию о распространенных задачах API см. в Руководстве разработчика .

JSON-представление 
{
  "deviceId": string,
  "serialNumber": string,
  "status": string,
  "lastSync": string,
  "supportEndDate": string,
  "annotatedUser": string,
  "annotatedLocation": string,
  "notes": string,
  "model": string,
  "meid": string,
  "orderNumber": string,
  "willAutoRenew": boolean,
  "osVersion": string,
  "platformVersion": string,
  "firmwareVersion": string,
  "macAddress": string,
  "bootMode": string,
  "lastEnrollmentTime": string,
  "kind": string,
  "recentUsers": [
    {
      "type": string,
      "email": string
    }
  ],
  "activeTimeRanges": [
    {
      "activeTime": integer,
      "date": string
    }
  ],
  "ethernetMacAddress": string,
  "annotatedAssetId": string,
  "etag": string,
  "diskVolumeReports": [
    {
      "volumeInfo": [
        {
          "volumeId": string,
          "storageTotal": string,
          "storageFree": string
        }
      ]
    }
  ],
  "systemRamTotal": string,
  "cpuStatusReports": [
    {
      "reportTime": string,
      "cpuUtilizationPercentageInfo": [
        integer
      ],
      "cpuTemperatureInfo": [
        {
          "temperature": integer,
          "label": string
        }
      ]
    }
  ],
  "cpuInfo": [
    {
      "model": string,
      "architecture": string,
      "maxClockSpeedKhz": integer,
      "logicalCpus": [
        {
          "maxScalingFrequencyKhz": integer,
          "currentScalingFrequencyKhz": integer,
          "idleDuration": string,
          "cStates": [
            {
              "displayName": string,
              "sessionDuration": string
            }
          ]
        }
      ]
    }
  ],
  "deviceFiles": [
    {
      "name": string,
      "type": string,
      "downloadUrl": string,
      "createTime": string
    }
  ],
  "systemRamFreeReports": [
    {
      "reportTime": string,
      "systemRamFreeInfo": [
        string
      ]
    }
  ],
  "lastKnownNetwork": [
    {
      "ipAddress": string,
      "wanIpAddress": string
    }
  ],
  "autoUpdateExpiration": string,
  "ethernetMacAddress0": string,
  "dockMacAddress": string,
  "manufactureDate": string,
  "orgUnitPath": string,
  "tpmVersionInfo": {
    "family": string,
    "specLevel": string,
    "manufacturer": string,
    "tpmModel": string,
    "firmwareVersion": string,
    "vendorSpecific": string
  },
  "screenshotFiles": [
    {
      "name": string,
      "type": string,
      "downloadUrl": string,
      "createTime": string
    }
  ],
  "orgUnitId": string,
  "osUpdateStatus": {
    object (OsUpdateStatus)
  },
  "firstEnrollmentTime": string,
  "lastDeprovisionTimestamp": string,
  "deprovisionReason": enum (DeprovisionReason),
  "deviceLicenseType": enum (DeviceLicenseType),
  "backlightInfo": [
    {
      object (BacklightInfo)
    }
  ],
  "autoUpdateThrough": string,
  "extendedSupportEligible": boolean,
  "extendedSupportStart": string,
  "extendedSupportEnabled": boolean,
  "fanInfo": [
    {
      object (FanInfo)
    }
  ],
  "chromeOsType": enum (ChromeOsType)
}
Поля
deviceId

string

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

serialNumber

string

Серийный номер устройства Chrome, введенный при включении устройства. Это значение совпадает с серийным номером консоли администратора на вкладке «Устройства Chrome OS» .

status

string

Статус устройства.

Приемлемые значения:

  • ACTIVE : Устройство зарегистрировано в домене.
  • DELINQUENT : Срок действия годовой лицензии для домена истек, и устройство больше не получает политики и настройки. При покупке новой лицензии устройство вернется в ACTIVE состояние.
  • PRE_PROVISIONED : устройство зарегистрировано для автоматической регистрации . Устройство PRE_PROVISIONED можно переместить в другое организационное подразделение или удалить. После завершения регистрации устройство станет ACTIVE .
  • DEPROVISIONED : устройство больше не может быть зарегистрировано в домене. Заказ отменен. Настройки устройства кэшированы на устройстве. Если устройство снова активируется, к этому вновь активированному устройству применяются последние системные настройки.
  • DISABLED : устройство отключено администратором и не может использоваться.
  • INACTIVE : Устройство не зарегистрировано в домене.
  • RETURN_ARRIVED : поступил запрос на замену этого устройства.
  • RETURN_REQUESTED : поступил запрос на замену этого устройства.
  • SHIPPED : устройство поставляется со склада Google. (Устарело)
  • UNKNOWN : Статус устройства определить невозможно.
lastSync

string

Дата и время последней синхронизации устройства с настройками политики в консоли администратора. Значение имеет формат даты и времени ISO 8601 . Время представляет собой полную дату плюс часы, минуты и секунды в формате YYYY-MM-DDThh:mm:ssTZD . Например, 2010-04-05T17:30:04+01:00 .

supportEndDate

string

Окончательная дата, когда устройство будет поддерживаться. Это применимо только к устройствам, приобретенным непосредственно у Google. Значение имеет формат даты и времени ISO 8601 . Время представляет собой полную дату плюс часы, минуты и секунды в формате YYYY-MM-DDThh:mm:ssTZD . Например, 2010-04-05T17:30:04+01:00 .

annotatedUser

string

Пользователь устройства, отмеченный администратором. Максимальная длина — 100 символов. Допускаются пустые значения.

annotatedLocation

string

Адрес или местоположение устройства, указанное администратором. Максимальная длина — 200 символов. Допускаются пустые значения.

notes

string

Заметки об этом устройстве добавлены администратором. Это свойство можно найти с помощью параметра query метода списка . Максимальная длина — 500 символов. Допускаются пустые значения.

model

string

Информация о модели устройства. Если устройство не имеет этой информации, это свойство не включается в ответ.

meid

string

Идентификатор мобильного оборудования (MEID) или международный идентификатор мобильного оборудования (IMEI) для мобильной карты 3G в мобильном устройстве. MEID/IMEI обычно используется при добавлении устройства в план обслуживания с постоплатой оператора беспроводной связи. Если устройство не имеет этой информации, это свойство не включается в ответ. Дополнительную информацию о том, как экспортировать список MEID/IMEI, см. в Руководстве разработчика .

orderNumber

string

Заказной номер устройства. Только устройства, приобретенные напрямую у Google, имеют номер заказа.

willAutoRenew

boolean

Определяет, будет ли устройство автоматически продлевать поддержку после даты окончания поддержки. Это свойство доступно только для чтения.

osVersion

string

Версия операционной системы устройства Chrome.

platformVersion

string

Версия платформы устройства Chrome.

firmwareVersion

string

Версия прошивки устройства Chrome.

macAddress

string

MAC-адрес беспроводной сети устройства. Если устройство не имеет этой информации, она не включается в ответ.

bootMode

string

Режим загрузки устройства. Возможные значения:

  • Verified : на устройстве установлена ​​действующая версия Chrome OS.
  • Dev : аппаратный переключатель разработчика устройства включен. При загрузке устройство имеет оболочку командной строки. Пример переключения разработчика см. в информации для разработчиков Chromebook .
lastEnrollmentTime

string

Дата и время последней регистрации устройства. Значение имеет формат даты и времени ISO 8601 . Время представляет собой полную дату плюс часы, минуты и секунды в формате YYYY-MM-DDThh:mm:ssTZD . Например, 2010-04-05T17:30:04+01:00 . Дополнительную информацию об автоматической и ручной регистрации см. в Справочном центре Chrome .

kind

string

Тип ресурса. Для ресурса Chromeosdevices используется значение admin#directory#chromeosdevice .

recentUsers[]

object

Список последних пользователей устройства в порядке убывания по времени последнего входа в систему.

recentUsers[].type

string

Тип пользователя.

Приемлемые значения:

  • USER_TYPE_MANAGED : пользователь управляется доменом.
  • USER_TYPE_UNMANAGED : пользователь не управляется доменом.
recentUsers[].email

string

Адрес электронной почты пользователя. Это присутствует только в том случае, если тип пользователя — USER_TYPE_MANAGED .

activeTimeRanges[]

object

Список активных временных диапазонов (только чтение).

activeTimeRanges[].activeTime

integer

Продолжительность использования в миллисекундах.

activeTimeRanges[].date

string

Дата использования.

ethernetMacAddress

string

MAC-адрес устройства на сетевом интерфейсе Ethernet.

annotatedAssetId

string

Идентификатор актива, указанный администратором или указанный при регистрации.

etag

string

ETag ресурса.

diskVolumeReports[]

object

Отчеты о дисковом пространстве и другая информация о смонтированных/подключенных томах.

diskVolumeReports[].volumeInfo[]

object

Дисковые тома

diskVolumeReports[].volumeInfo[].volumeId

string

Идентификатор тома

diskVolumeReports[].volumeInfo[].storageTotal

string ( int64 format)

Общий объем дискового пространства [в байтах]

diskVolumeReports[].volumeInfo[].storageFree

string ( int64 format)

Свободное место на диске [в байтах]

systemRamTotal

string ( int64 format)

Общий объем оперативной памяти на устройстве в байтах

cpuStatusReports[]

object

Отчеты об использовании и температуре процессора (только чтение)

cpuStatusReports[].reportTime

string

Дата и время получения отчета.

cpuStatusReports[].cpuUtilizationPercentageInfo[]

integer

cpuStatusReports[].cpuTemperatureInfo[]

object

Список образцов температуры процессора.

cpuStatusReports[].cpuTemperatureInfo[].temperature

integer

Температура в градусах Цельсия.

cpuStatusReports[].cpuTemperatureInfo[].label

string

Этикетка процессора

cpuInfo[]

object

Информация о характеристиках процессора устройства.

cpuInfo[].model

string

Название модели ЦП.

cpuInfo[].architecture

string

Архитектура процессора.

cpuInfo[].maxClockSpeedKhz

integer

Максимальная тактовая частота процессора в кГц.

cpuInfo[].logicalCpus[]

object

Информация для логических процессоров

cpuInfo[].logicalCpus[].maxScalingFrequencyKhz

integer

Максимальная частота, на которой процессор может работать в соответствии с политикой.

cpuInfo[].logicalCpus[].currentScalingFrequencyKhz

integer

Текущая частота, на которой работает процессор.

cpuInfo[].logicalCpus[].idleDuration

string ( Duration format)

Время простоя с момента последней загрузки.

Продолжительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

cpuInfo[].logicalCpus[].cStates[]

object

C-состояния указывают состояние энергопотребления ЦП. Для получения дополнительной информации обратитесь к документации, опубликованной производителем процессора.

cpuInfo[].logicalCpus[].cStates[].displayName

string

Название штата.

cpuInfo[].logicalCpus[].cStates[].sessionDuration

string ( Duration format)

Время нахождения в состоянии с момента последней перезагрузки.

Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

deviceFiles[]

object

Список файлов устройства для загрузки (только для чтения)

deviceFiles[].name

string

Имя файла

deviceFiles[].type

string

Тип файла

deviceFiles[].downloadUrl

string

URL-адрес загрузки файла

deviceFiles[].createTime

string

Дата и время создания файла

systemRamFreeReports[]

object

Отчеты об объемах доступной оперативной памяти (только чтение)

systemRamFreeReports[].reportTime

string

Дата и время получения отчета.

systemRamFreeReports[].systemRamFreeInfo[]

string ( int64 format)

lastKnownNetwork[]

object

Содержит последнюю известную сеть (только чтение)

lastKnownNetwork[].ipAddress

string

IP-адрес.

lastKnownNetwork[].wanIpAddress

string

IP-адрес WAN.

autoUpdateExpiration
(deprecated)

string ( int64 format)

(Только для чтения) Временная метка, после которой устройство перестанет получать обновления или поддержку Chrome. Вместо этого используйте «autoUpdateThrough».

ethernetMacAddress0

string

(Только для чтения) MAC-адрес, используемый внутренним портом Ethernet Chromebook и встроенным сетевым интерфейсом (Ethernet). Формат — двенадцать (12) шестнадцатеричных цифр без разделителя (прописные буквы). Это актуально только для некоторых устройств.

dockMacAddress

string

(Только для чтения) Встроенный MAC-адрес док-станции, к которой подключено устройство. Заводские настройки: адрес управления доступом к среде передачи данных (MAC-адрес), назначенный для использования док-станцией. Он зарезервирован специально для политики прохождения MAC-адресов устройств. Формат — двенадцать (12) шестнадцатеричных цифр без разделителя (прописные буквы). Это актуально только для некоторых устройств.

manufactureDate

string

(Только для чтения) Дата изготовления устройства в формате гггг-мм-дд.

orgUnitPath

string

Полный родительский путь с названием организационного подразделения, связанного с устройством. Имена путей нечувствительны к регистру. Если родительская организационная единица является организацией верхнего уровня, она обозначается косой чертой / . Это свойство можно обновить с помощью API. Дополнительную информацию о том, как создать организационную структуру для вашего устройства, см. в справочном центре администрирования .

tpmVersionInfo

object

Доверенный платформенный модуль (TPM) (только чтение)

tpmVersionInfo.family

string

Семья ТПМ. Мы используем кодировку стиля TPM 2.0, например:
TPM 1.2: «1.2» -> 312e3200
Доверенный платформенный модуль 2.0: «2.0» -> 322e3000

tpmVersionInfo.specLevel

string

Уровень спецификации TPM. См. спецификацию библиотеки для TPM 2.0 и основную спецификацию для TPM 1.2.

tpmVersionInfo.manufacturer

string

Код производителя TPM.

tpmVersionInfo.tpmModel

string

Номер модели TPM.

tpmVersionInfo.firmwareVersion

string

Версия прошивки TPM.

tpmVersionInfo.vendorSpecific

string

Информация, специфичная для поставщика, такая как идентификатор поставщика.

screenshotFiles[]

object

Список файлов скриншотов для загрузки. Тип всегда «SCREENSHOT_FILE». (Только чтение)

screenshotFiles[].name

string

Имя файла

screenshotFiles[].type

string

Тип файла

screenshotFiles[].downloadUrl

string

URL-адрес загрузки файла

screenshotFiles[].createTime

string

Дата и время создания файла

orgUnitId

string

Уникальный идентификатор организационного подразделения. orgUnitPath — это удобочитаемая версия orgUnitId. Хотя orgUnitPath можно изменить путем переименования организационного подразделения в пути, orgUnitId нельзя изменить ни для одного организационного подразделения. Это свойство можно обновить с помощью API. Дополнительную информацию о том, как создать организационную структуру для вашего устройства, см. в справочном центре администрирования .

osUpdateStatus

object ( OsUpdateStatus )

Статус обновлений ОС для устройства.

firstEnrollmentTime

string

Дата и время первой регистрации устройства.

lastDeprovisionTimestamp

string

(Только для чтения) Дата и время последней деинициализации устройства.

deprovisionReason

enum ( DeprovisionReason )

(Только чтение) Причина деинициализации.

deviceLicenseType

enum ( DeviceLicenseType )

Только вывод. Тип лицензии на устройство.

backlightInfo[]

object ( BacklightInfo )

Только вывод. Содержит информацию о подсветке устройства.

autoUpdateThrough

string

Только вывод. Временная метка, после которой устройство перестанет получать обновления или поддержку Chrome.

extendedSupportEligible

boolean

Только вывод. Требуется ли для устройства согласие на расширенную поддержку.

extendedSupportStart

string

Только вывод. Дата устройства, когда начинается политика расширенной поддержки автоматических обновлений.

extendedSupportEnabled

boolean

Только вывод. Включена ли на устройстве политика расширенной поддержки.

fanInfo[]

object ( FanInfo )

Только вывод. Информация о вентиляторе устройства.

chromeOsType

enum ( ChromeOsType )

Только вывод. Тип Chrome OS устройства.

Осупдатестатус

Содержит информацию о текущем состоянии обновления ОС.

JSON-представление 
{
  "state": enum (UpdateState),
  "targetOsVersion": string,
  "targetKioskAppVersion": string,
  "updateTime": string,
  "updateCheckTime": string,
  "rebootTime": string
}
Поля
state

enum ( UpdateState )

Состояние обновления ОС.

targetOsVersion

string

Новая версия образа ОС загружается и применяется. Он устанавливается только в том случае, если статус обновления — UPDATE_STATUS_DOWNLOAD_IN_PROGRESS или UPDATE_STATUS_NEED_REBOOT. Обратите внимание, что это может быть фиктивное значение «0.0.0.0» для UPDATE_STATUS_NEED_REBOOT в некоторых крайних случаях, например, механизм обновления перезапускается без перезагрузки.

targetKioskAppVersion

string

Новая необходимая версия платформы из ожидаемого обновленного киоск-приложения.

updateTime

string

Дата и время последнего успешного обновления ОС.

updateCheckTime

string

Дата и время последней проверки обновлений.

rebootTime

string

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

Обновлениестате

Состояние обновления ОС.

Перечисления
UPDATE_STATE_UNSPECIFIED Состояние обновления не указано.
UPDATE_STATE_NOT_STARTED Ожидается обновление, но оно еще не запущено.
UPDATE_STATE_DOWNLOAD_IN_PROGRESS Ожидаемое обновление загружается.
UPDATE_STATE_NEED_REBOOT Устройство готово к установке обновления, но должно перезагрузиться.

Причина деинициализации

Причина деинициализации устройства ChromeOS.

Перечисления
DEPROVISION_REASON_UNSPECIFIED Причина отключения неизвестна.
DEPROVISION_REASON_SAME_MODEL_REPLACEMENT Замена той же модели. У вас есть разрешение на возврат материалов (RMA) или вы заменяете неисправное устройство по гарантии на устройство той же модели.
DEPROVISION_REASON_UPGRADE

Устройство было модернизировано.

DEPROVISION_REASON_DOMAIN_MOVE

Домен устройства был изменен.

DEPROVISION_REASON_SERVICE_EXPIRATION

Срок действия услуги для устройства истек.

DEPROVISION_REASON_OTHER

Устройство было деинициализировано по устаревшей причине, которая больше не поддерживается.

DEPROVISION_REASON_DIFFERENT_MODEL_REPLACEMENT Замена другой модели. Вы заменяете это устройство на обновленную или более новую модель устройства.
DEPROVISION_REASON_RETIRING_DEVICE Уход из флота. Вы передаете, выбрасываете или иным образом выводите устройство из использования.
DEPROVISION_REASON_UPGRADE_TRANSFER Перенос обновления ChromeOS Flex. Это устройство ChromeOS Flex, которое вы заменяете на Chromebook в течение года.
DEPROVISION_REASON_NOT_REQUIRED Причина не требовалась. Например, лицензии были возвращены в пул лицензий клиента.
DEPROVISION_REASON_REPAIR_CENTER Устройство было деинициализировано Сервисным центром ремонта. Может быть установлен только сервисным центром ремонта во время RMA.

Тип лицензии устройства

Тип лицензии этого устройства.

Перечисления
DEVICE_LICENSE_TYPE_UNSPECIFIED Тип лицензии неизвестен.
ENTERPRISE Устройство поставляется с бессрочным обновлением Chrome Enterprise.
ENTERPRISE_UPGRADE Для устройства предоставляется ежегодное автономное обновление Chrome Enterprise.
EDUCATION_UPGRADE Устройство имеет бессрочную автономную версию Chrome Education Upgrade.
EDUCATION В комплект поставки устройства входит бессрочное обновление Chrome Education.
KIOSK_UPGRADE Устройство имеет ежегодное обновление киоска.

Информация о подсветке

Информация о подсветке устройства.

JSON-представление 
{
  "path": string,
  "maxBrightness": integer,
  "brightness": integer
}
Поля
path

string

Только вывод. Путь к этой подсветке в системе. Полезно, если вызывающему абоненту необходимо сопоставить другую информацию.

maxBrightness

integer

Только вывод. Максимальная яркость подсветки.

brightness

integer

Только вывод. Текущая яркость подсветки, от 0 до maxBrightness.

ФанИнфо

Информация о вентиляторе устройства.

JSON-представление 
{
  "speedRpm": integer
}
Поля
speedRpm

integer

Только вывод. Скорость вентилятора в об/мин.

ChromeOsType

Тип Chrome OS устройства.

Перечисления
CHROME_OS_TYPE_UNSPECIFIED Тип ОС Chrome не указан.
CHROME_OS_FLEX Тип ОС Chrome. Chrome OS Flex.
CHROME_OS ОС Chrome Введите ОС Chrome.

Методы

action
(deprecated)

 Вместо этого используйте BatchChangeChromeOsDeviceStatus .

get

 Получает свойства устройства Chrome OS.

list

 Получает постраничный список устройств Chrome OS в учетной записи.

moveDevicesToOu

 Перемещает или добавляет несколько устройств Chrome OS в организационное подразделение.

patch

 Обновляет обновляемые свойства устройства, такие как annotatedUser , annotatedLocation , notes , orgUnitPath или annotatedAssetId .

update

 Обновляет обновляемые свойства устройства, такие как annotatedUser , annotatedLocation , notes , orgUnitPath или annotatedAssetId .