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)
}
字段
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

string (int64 format)

(只读)设备停止接收 Chrome 更新或支持的时间戳

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,但对于一个组织部门,组织部门 ID 不可更改。您可以使用 API 更新此属性。要详细了解如何为设备创建组织结构,请参阅管理帮助中心

osUpdateStatus

object (OsUpdateStatus)

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

firstEnrollmentTime

string

设备首次注册的日期和时间。

lastDeprovisionTimestamp

string

(只读)上次取消配置设备的日期和时间。

deprovisionReason

enum (DeprovisionReason)

(只读)取消配置的原因。

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 设备已准备好安装更新,但必须重新启动。

取消配置原因

取消配置设备的原因。

枚举
DEPROVISION_REASON_UNSPECIFIED 取消配置的原因未知。
DEPROVISION_REASON_SAME_MODEL_REPLACEMENT 设备已替换为型号相同的设备。
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 此设备的永久升级许可已转移到新设备。
DEPROVISION_REASON_NOT_REQUIRED 不需要提供原因。例如,将许可退回客户的许可池。
DEPROVISION_REASON_REPAIR_CENTER 维修服务中心取消配置了该设备。

方法

action

执行会影响 Chrome 操作系统设备的操作。

get

检索 Chrome 操作系统设备的属性。

list

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

moveDevicesToOu

将多个 Chrome 操作系统设备移动或插入到一个单位部门。

patch

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

update

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