REST Resource: chromeosdevices

透過集合功能整理內容 你可以依據偏好儲存及分類內容。

資源:ChromeOsDevice

搭載 Chrome 作業系統的 Google 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 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

管理員新增的這個裝置相關附註。您可以使用 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:裝置的開發人員硬體開關已啟用。裝置啟動時,裝置會有指令列殼層。如需開發人員切換版本的範例,請參閱 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)

上次啟動後閒置時間。

持續時間以秒為單位,最多 9 個小數位數,結尾為「s」。範例:"3.5s"

cpuInfo[].logicalCpus[].cStates[]

object

C 狀態表示 CPU 的耗電量。如需詳細資訊,請參閱 CPU 製作工具發布的文件。

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

string

州名。

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

string (Duration format)

自上次重新啟動以來處於狀態的時間。

持續時間以秒為單位,最多 9 個小數位數,結尾為「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 位址),以供 Dock 使用。專為 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 可能會變更路徑中的機構單位來變更,但 1 個機構單位無法變更。您可以使用 API 更新這個屬性。如要進一步瞭解如何為您的裝置建立機構架構,請參閱管理員說明中心

osUpdateStatus

object (OsUpdateStatus)

裝置的作業系統更新狀態。

firstEnrollmentTime

string

首次註冊裝置的日期和時間。

lastDeprovisionTimestamp

string

(唯讀) 裝置上次取消佈建時間的日期和時間。

deprovisionReason

enum (DeprovisionReason)

(唯讀) 取消佈建原因。

更新狀態

內含目前作業系統更新狀態的相關資訊。

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

待更新 Kiosk 應用程式的新必要平台版本。

updateTime

string

上次成功更新作業系統的日期和時間。

updateCheckTime

string

上次更新檢查的日期和時間。

rebootTime

string

上次重新啟動的日期和時間。

更新狀態

作業系統更新的更新狀態。

列舉
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 OS 裝置的動作。

get

擷取 Chrome 作業系統裝置的屬性。

list

擷取帳戶內分頁的 Chrome OS 裝置清單。

moveDevicesToOu

將多個 Chrome 作業系統裝置移至或插入特定機構單位。

patch

更新裝置的可更新屬性,例如 annotatedUserannotatedLocationnotesorgUnitPathannotatedAssetId

update

更新裝置的可更新屬性,例如 annotatedUserannotatedLocationnotesorgUnitPathannotatedAssetId