REST Resource: chromeosdevices

资源:ChromeOsDevice

Google Chrome 设备运行的是 Chrome 操作系统。如需详细了解常见的 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 设备的唯一 ID。

serialNumber

string

启用设备时输入的 Chrome 设备序列号。此值与管理控制台 Chrome 操作系统设备标签页中的序列号相同。

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

管理员添加的关于此设备的备注。您可以使用 list 方法的 query 参数搜索此属性。长度上限为 500 个字符。允许为空值。

model

string

设备的型号信息。如果设备没有此信息,则此属性不会包含在响应中。

meid

string

移动设备上 3G 移动卡的移动设备标识符 (MEID) 或国际移动设备识别码 (IMEI)。将设备添加到无线运营商的后付款服务计划时,通常会用到 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 操作系统。
  • Dev:设备的开发者硬件开关已启用。启动时,设备将有一个命令行 shell。要查看切换开发者的示例,请参阅 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 地址。

annotatedAssetId

string

管理员标注或注册时指定的资产标识符。

etag

string

资源的 ETag。

diskVolumeReports[]

object

磁盘可用空间报告,以及装载/连接的卷相关的其他信息。

diskVolumeReports[].volumeInfo[]

object

磁盘卷

diskVolumeReports[].volumeInfo[].volumeId

string

卷 ID

diskVolumeReports[].volumeInfo[].storageTotal

string (int64 format)

总磁盘空间 [以字节为单位]

diskVolumeReports[].volumeInfo[].storageFree

string (int64 format)

可用磁盘空间 [以字节为单位]

systemRamTotal

string (int64 format)

设备上的 RAM 总容量(以字节为单位

cpuStatusReports[]

object

CPU 利用率和温度报告(只读)

cpuStatusReports[].reportTime

string

收到报告的日期和时间。

cpuStatusReports[].cpuUtilizationPercentageInfo[]

integer

cpuStatusReports[].cpuTemperatureInfo[]

object

CPU 温度样本列表。

cpuStatusReports[].cpuTemperatureInfo[].temperature

integer

以摄氏度为单位的温度。

cpuStatusReports[].cpuTemperatureInfo[].label

string

CPU 标签

cpuInfo[]

object

有关设备 CPU 规格的信息。

cpuInfo[].model

string

CPU 型号名称。

cpuInfo[].architecture

string

CPU 架构。

cpuInfo[].maxClockSpeedKhz

integer

最高 CPU 时钟速度,以千赫 (kHz) 为单位。

cpuInfo[].logicalCpus[]

object

逻辑 CPU 的信息

cpuInfo[].logicalCpus[].maxScalingFrequencyKhz

integer

根据政策,CPU 可以运行的最高频率。

cpuInfo[].logicalCpus[].currentScalingFrequencyKhz

integer

CPU 当前的运行频率。

cpuInfo[].logicalCpus[].idleDuration

string (Duration format)

自上次启动以来的空闲时间。

该时长以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

cpuInfo[].logicalCpus[].cStates[]

object

C 状态表示 CPU 的功耗状态。如需了解详情,请参阅 CPU 制造商发布的文档。

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

文件下载网址

deviceFiles[].createTime

string

文件的创建日期和时间

systemRamFreeReports[]

object

可用 RAM 内存量的报告(只读)

systemRamFreeReports[].reportTime

string

收到报告的日期和时间。

systemRamFreeReports[].systemRamFreeInfo[]

string (int64 format)

lastKnownNetwork[]

object

包含最后已知网络(只读)

lastKnownNetwork[].ipAddress

string

IP 地址。

lastKnownNetwork[].wanIpAddress

string

WAN IP 地址。

autoUpdateExpiration
(deprecated)

string (int64 format)

(只读)一个时间戳,在此时间戳过后,设备将停止接收 Chrome 更新或支持服务。请使用“autoUpdateThrough”。

ethernetMacAddress0

string

(只读)MAC 地址,供 Chromebook 的内部以太网端口和板载网络(以太网)接口使用。格式为十二 (12) 个十六进制数字,不含任何分隔符(大写字母)。这仅与某些设备有关。

dockMacAddress

string

(只读)设备连接到的坞站的内置 MAC 地址。出厂设置分配供基座使用的媒体访问控制地址(MAC 地址)。它专用于 MAC 传递设备政策。格式为十二 (12) 个十六进制数字,不含任何分隔符(大写字母)。这仅与某些设备有关。

manufactureDate

string

(只读)设备的制造日期,格式为 yyyy-mm-dd。

orgUnitPath

string

包含与设备相关联的组织部门名称的完整父级路径。路径名称不区分大小写。如果上级组织部门是顶级组织,则以正斜杠 / 表示。可以使用 API 更新此属性。要详细了解如何为设备创建组织结构,请访问管理帮助中心

tpmVersionInfo

object

可信平台模块 (TPM)(只读)

tpmVersionInfo.family

string

TPM 系列。我们使用 TPM 2.0 样式的编码,例如:
TPM 1.2:“1.2”->312e3200
TPM 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

供应商特定信息,例如供应商 ID。

screenshotFiles[]

object

要下载的屏幕截图文件列表。类型始终为“SCREENSHOT_FILE”。(只读)

screenshotFiles[].name

string

文件名

screenshotFiles[].type

string

文件类型

screenshotFiles[].downloadUrl

string

文件下载网址

screenshotFiles[].createTime

string

文件的创建日期和时间

orgUnitId

string

组织部门的唯一 ID。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)

仅限输出。设备的 ChromeOS 类型。

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

上次重新启动的日期和时间。

UpdateState

操作系统更新的更新状态。

枚举
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 升级转移。这是一台您准备在一年内更换为 Chromebook 的 ChromeOS Flex 设备。
DEPROVISION_REASON_NOT_REQUIRED 原因不明。例如,许可已退回客户的许可库。
DEPROVISION_REASON_REPAIR_CENTER 设备已被维修服务中心取消配置。只能在 RMA 期间由维修服务中心设置。

DeviceLicenseType

此设备的许可类型。

枚举
DEVICE_LICENSE_TYPE_UNSPECIFIED 许可类型未知。
ENTERPRISE 设备捆绑了永久 Chrome 企业版升级许可。
ENTERPRISE_UPGRADE 设备拥有年度独立 Chrome 企业版升级许可。
EDUCATION_UPGRADE 设备拥有永久独立的 Chrome 教育版升级许可。
EDUCATION 设备捆绑了永久的 Chrome 教育版升级许可。
KIOSK_UPGRADE 设备拥有年度自助服务终端升级许可。

BacklightInfo

设备背光的相关信息。

JSON 表示法
{
  "path": string,
  "maxBrightness": integer,
  "brightness": integer
}
字段
path

string

仅限输出。系统上此背光的路径。如果调用方需要与其他信息相关联,此类型会非常有用。

maxBrightness

integer

仅限输出。背光的最大亮度。

brightness

integer

仅限输出。背光的当前亮度,介于 0 和 maxBrightness 之间。

FanInfo

设备风扇的相关信息。

JSON 表示法
{
  "speedRpm": integer
}
字段
speedRpm

integer

仅限输出。风扇转速,以每千次展示收入 (RPM) 为单位。

ChromeOsType

设备的 ChromeOS 类型。

枚举
CHROME_OS_TYPE_UNSPECIFIED 未指定 Chrome 操作系统类型。
CHROME_OS_FLEX Chrome 操作系统类型:Chrome OS Flex。
CHROME_OS Chrome 操作系统类型:Chrome 操作系统。

方法

action
(deprecated)

请改用 BatchChangeChromeOsDeviceStatus

get

检索 ChromeOS 设备的属性。

list

检索账号中 Chrome 操作系统设备的分页列表。

moveDevicesToOu

将多台 Chrome 操作系统设备移动或插入一个组织部门。

patch

更新设备的可更新属性,如 annotatedUserannotatedLocationnotesorgUnitPathannotatedAssetId

update

更新设备的可更新属性,如 annotatedUserannotatedLocationnotesorgUnitPathannotatedAssetId