REST Resource: chromeosdevices

资源：ChromeOsDevice

Google Chrome 设备搭载 ChromeOS。如需详细了解常见的 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 设备的唯一 ID。
serialNumber

string

设备启用时输入的 Chrome 设备序列号。此值与管理控制台的 ChromeOS 设备标签页中的序列号相同。
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：设备运行的是有效版本的 ChromeOS。
  • 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-state 表示 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

（只读）Chromebook 内部以太网端口和板载网络（以太网）接口使用的 MAC 地址。格式为 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 类型。
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 时，才会设置此值。请注意，对于某些极端情况（例如，更新引擎在未重启的情况下重启），UPDATE_STATUS_NEED_REBOOT 可能为虚构的“0.0.0.0”。
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 未指定 ChromeOS 类型。
CHROME_OS_FLEX ChromeOS 类型 ChromeOS Flex。
CHROME_OS ChromeOS 类型 ChromeOS。

ByteUsage

表示数据容量以及当前用量（以字节为单位）。

JSON 表示法 
{
  "capacityBytes": string,
  "usedBytes": string
}
字段
capacityBytes

string (int64 format)

仅限输出。总容量值（以字节为单位）。
usedBytes

string (int64 format)

仅限输出。当前用量值（以字节为单位）。

方法

action
(deprecated)

 请改用 BatchChangeChromeOsDeviceStatus。

get

 检索 ChromeOS 设备的属性。

list

 检索账号中 ChromeOS 设备的分页列表。

moveDevicesToOu

 将多台 ChromeOS 设备移至或插入组织部门。

patch

 更新设备的可更新属性，例如 annotatedUser、annotatedLocation、notes、orgUnitPath 或 annotatedAssetId。

update

 更新设备的可更新属性，例如 annotatedUser、annotatedLocation、notes、orgUnitPath 或 annotatedAssetId。