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)
}
欄位
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 行動卡的行動裝置設備 ID (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 OS 版本。
  • Dev:已啟用裝置的開發人員硬體切換按鈕。裝置在啟動時會啟動指令列殼層。如需開發人員開關的範例,請參閱 Chromebook 開發人員資訊
lastEnrollmentTime

string

裝置上次註冊的日期和時間。格式為 ISO 8601 日期和時間格式。時間是完整日期加上時、分、秒 (格式為 YYYY-MM-DDThh:mm:ssTZD)。例如 2010-04-05T17:30:04+01:00。如要進一步瞭解自動和手動註冊,請造訪 Chrome 說明中心

kind

string

資源類型。Chrome OS 裝置的值為 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

管理員指定或資產註冊時指定的資產 ID。

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

最大 kHz 的 CPU 時脈速度速度。

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-State 表示 CPU 的耗電量。如要進一步瞭解 CPU 製造商發布的說明文件,

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

string

州/省的名稱。

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

string (Duration format)

上次重新啟動後狀態停留的時間。

效期以秒為單位,最多 9 個小數位數,結尾為「s」。例如:"3.5s"

deviceFiles[]

object

要下載的裝置檔案清單 (唯讀)

deviceFiles[].name

string

「File name」

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 (12) 十六進位數字,不含任何分隔符號 (大寫字母)。這項做法僅適用於部分裝置。

dockMacAddress

string

(唯讀) 裝置插入座架所在的 MAC 位址。恢復原廠設定會將媒體存取控制位址 (MAC 位址) 指派給 Dock 使用。專為 MAC 位址傳遞裝置政策而專門保留。格式為 12 (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

「File name」

screenshotFiles[].type

string

檔案類型

screenshotFiles[].downloadUrl

string

檔案下載網址

screenshotFiles[].createTime

string

檔案的建立日期和時間

orgUnitId

string

機構單位的專屬 ID。orgUnitPath 是使用者可理解的 orgUnitId 版本。雖然 orgUnitPath 可以重新命名路徑中的機構單位,但某個機構單位無法變更 orgUnitId。您可以使用 API 更新這個屬性。如要進一步瞭解如何為裝置建立機構架構,請參閱管理說明中心

osUpdateStatus

object (OsUpdateStatus)

OS 裝置狀態的狀態。

firstEnrollmentTime

string

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

lastDeprovisionTimestamp

string

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

deprovisionReason

enum (DeprovisionReason)

(唯讀) 取消佈建原因。

deviceLicenseType

enum (DeviceLicenseType)

僅供輸出。裝置授權類型。

最新狀態

包含目前的 OS 更新狀態。

JSON 表示法
{
  "state": enum (UpdateState),
  "targetOsVersion": string,
  "targetKioskAppVersion": string,
  "updateTime": string,
  "updateCheckTime": string,
  "rebootTime": string
}
欄位
state

enum (UpdateState)

OS 更新的更新狀態。

targetOsVersion

string

下載及套用新的 OS 映像檔版本。只有在更新狀態為 UPDATE_STATUS_UPLOAD_IN_PROGRESS 或 UPDATE_STATUS_NEED_REBOOT 時,系統才會設定此參數。請注意,如果是某些更新案例,情況可能為 UPDATE_STATUS_NEED_REBOOT 的虛擬版「0.0.0.0」。舉例來說,系統會在不重新啟動的情況下重新啟動更新引擎。

targetKioskAppVersion

string

從待處理更新資訊站應用程式所需的新平台版本。

updateTime

string

上次成功 OS 更新的日期和時間。

updateCheckTime

string

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

rebootTime

string

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

UpdateState

OS 更新的更新狀態。

列舉
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 裝置已從維修服務中心取消佈建。

裝置授權類型

這部裝置的授權類型。

列舉
DEVICE_LICENSE_TYPE_UNSPECIFIED 執照類型不明。
ENTERPRISE 裝置隨附 Chrome Enterprise 升級版。
ENTERPRISE_UPGRADE 該裝置每年都會有 Chrome Enterprise 升級版,
EDUCATION_UPGRADE 裝置是獨立的獨立 Chrome Education 升級版。
EDUCATION 裝置隨附永久 Chrome Education 升級版。
KIOSK_UPGRADE 裝置具備年約 Kiosk 升級版。

方法

action

執行會影響 Chrome OS 裝置的動作。

get

擷取 Chrome OS 裝置的屬性。

list

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

moveDevicesToOu

將多個 Chrome OS 裝置移至或插入機構單位。

patch

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

update

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