Method: customer.devices.chromeos.batchChangeStatus

變更一批 ChromeOS 裝置的狀態。如要進一步瞭解如何變更 ChromeOS 裝置狀態，請參閱「將 ChromeOS 裝置送修、淘汰或用於其他目的」。

HTTP 要求

POST https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/devices/chromeos:batchChangeStatus

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
customerId

string

必要欄位。Google Workspace 帳戶的不可變更 ID。

要求主體

要求主體的資料會採用以下結構：

JSON 表示法 
{
  "deviceIds": [
    string
  ],
  "changeChromeOsDeviceStatusAction": enum (ChangeChromeOsDeviceStatusAction),
  "deprovisionReason": enum (DeprovisionReason)
}
欄位
deviceIds[]

string

必要欄位。要變更的 ChromeOS 裝置 ID 清單。上限為 50 個。
changeChromeOsDeviceStatusAction

enum (ChangeChromeOsDeviceStatusAction)

必要欄位。要對 ChromeOS 裝置採取的動作，以便變更狀態。
deprovisionReason

enum (DeprovisionReason)

選用設定。取消佈建裝置的原因。如果「changeChromeOsDeviceStatusAction」設為「CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION」，則必須提供。否則，請略過這個欄位。

回應主體

針對一批 ChromeOS 裝置變更狀態的回應。

如果成功，回應主體即會包含具有以下結構的資料：

JSON 表示法 
{
  "changeChromeOsDeviceStatusResults": [
    {
      object (ChangeChromeOsDeviceStatusResult)
    }
  ]
}
欄位
changeChromeOsDeviceStatusResults[]

object (ChangeChromeOsDeviceStatusResult)

要求中提供的每部 ChromeOS 裝置結果。

授權範圍

需要下列 OAuth 範圍：

  • https://www.googleapis.com/auth/admin.directory.device.chromeos

詳情請參閱授權指南。

ChangeChromeOsDeviceStatusAction

為了變更 ChromeOS 裝置狀態所執行的動作。

列舉
CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_UNSPECIFIED 預設值。未使用任何值。
CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION 取消佈建 ChromeOS 裝置。如果貴機構有不再使用的 ChromeOS 裝置，請取消佈建這些裝置，這樣一來，裝置就會排除在管理範圍外。取消佈建裝置會移除裝置上的所有政策和裝置層級印表機，而且裝置將無法做為資訊站使用。根據與裝置相關的升級授權，這項操作可能會將授權復原回授權集區，方便您在其他裝置上使用該授權。
CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DISABLE 停用 ChromeOS 裝置。當使用者遺失裝置或遭竊時，只要裝置處於受管理的狀態，裝置仍會受到管理，仍會接受政策，但任何人都無法使用裝置。根據與裝置相關的升級授權，這項操作可能會將授權復原回授權集區，方便您在其他裝置上使用該授權。
CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_REENABLE 重新啟用停用後仍可使用的 ChromeOS 裝置。當裝置不再遺失或已復原後，請重新啟用裝置。這樣做即可再次使用裝置。根據與裝置相關聯的升級授權，可能會使用授權集區中的一個授權，如果可用授權數不足，作業就會失敗。

ChangeChromeOsDeviceStatusResult

單一 ChromeOS 裝置對變更狀態作業的結果。

JSON 表示法 
{
  "deviceId": string,

  // Union field result can be only one of the following:
  "error": {
    object (Status)
  },
  "response": {
    object (ChangeChromeOsDeviceStatusSucceeded)
  }
  // End of list of possible types for union field result.
}
欄位
deviceId

string

ChromeOS 裝置的專屬 ID。

聯集欄位 result。

result 只能採用下列其中一種設定：
error

object (Status)

作業失敗時的錯誤結果。
response

object (ChangeChromeOsDeviceStatusSucceeded)

裝置可能會成功變更裝置狀態。

狀態

Status 類型會定義適用於不同程式設計環境 (包含 REST API 和遠端程序呼叫 (RPC) API) 的邏輯錯誤模型。gRPC 會使用這個模型。每個 Status 訊息包含三部分的資料：錯誤代碼、錯誤訊息和錯誤詳細資料。

如要進一步瞭解這個錯誤模型，以及如何使用這個錯誤模型，請參閱 API 設計指南。

JSON 表示法 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
欄位
code

integer

狀態碼，應為 google.rpc.Code 的列舉值。
message

string

向開發人員顯示的錯誤訊息，應以英文呈現。任何向使用者顯示的錯誤訊息都應進行本地化並透過 google.rpc.Status.details 欄位傳送，或是由用戶端加以本地化。
details[]

object

包含錯誤詳細資料的訊息清單。這是供 API 使用的一組常用訊息類型。

包含任意類型欄位的物件。額外的 "@type" 欄位則包含能辨識類型的 URI。例如：{ "id": 1234, "@type": "types.example.com/standard/id" }.

ChangeChromeOsDeviceStatusSucceeded

這個類型沒有任何欄位。

對 ChromeOS 裝置狀態成功變更的回應。