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),
  "diskSpaceUsage": {
    object (ByteUsage)
  }
}
Поля
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 метода list . Максимальная длина — 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-States указывают состояние энергопотребления ЦП. Для получения дополнительной информации см. документацию, опубликованную производителем ЦП.

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. Мы используем кодировку в стиле TPM 2.0, например:
ТРМ 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 устройства.

diskSpaceUsage

object ( ByteUsage )

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

OsUpdateStatus

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

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 Устройство готово к установке обновления, но его необходимо перезагрузить.

DeprovisionReason

Причина деинициализации устройства 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 Upgrade.
ENTERPRISE_UPGRADE

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

EDUCATION_UPGRADE

Устройство имеет постоянную автономную версию Chrome Education Upgrade.

EDUCATION Устройство поставляется в комплекте с бессрочной подпиской Chrome Education Upgrade.
KIOSK_UPGRADE Устройство имеет ежегодную услугу обновления киоска.
ENTERPRISE_UPGRADE_PERPETUAL Указывает, что устройство использует автономное постоянное обновление Chrome Enterprise, лицензию Chrome Enterprise.
ENTERPRISE_UPGRADE_FIXED_TERM Указывает, что устройство использует отдельную лицензию Chrome Enterprise Upgrade с фиксированным сроком действия — Chrome Enterprise.
EDUCATION_UPGRADE_PERPETUAL Указывает, что устройство использует автономную бессрочную лицензию Chrome Education Upgrade (также известную как бессрочная лицензия Chrome EDU).
EDUCATION_UPGRADE_FIXED_TERM Указывает, что устройство использует автономную лицензию Chrome Education Upgrade с фиксированным сроком действия (также известную как лицензия Chrome EDU с фиксированным сроком действия).

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

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

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 OS не указан.
CHROME_OS_FLEX Chrome OS Type Chrome OS Flex.
CHROME_OS Тип Chrome OS Chrome OS.

БайтИспользование

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

JSON-представление 
{
  "capacityBytes": string,
  "usedBytes": string
}
Поля
capacityBytes

string ( int64 format)

Только вывод. Общее значение емкости в байтах.

usedBytes

string ( int64 format)

Только вывод. Текущее значение использования, в байтах.

Методы

action
(deprecated)

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

get

 Извлекает свойства устройства Chrome OS.

list

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

moveDevicesToOu

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

patch

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

update

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