更改一批 ChromeOS 设备的状态。如需详细了解如何更改 ChromeOS 设备状态,请参阅维修 ChromeOS 设备、将 ChromeOS 设备改作他用或淘汰。
HTTP 请求
POST https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/devices/chromeos:batchChangeStatus
网址采用 gRPC 转码语法。
路径参数
| 参数 | |
|---|---|
| customerId | 
 必需。Google Workspace 账号的不可变 ID。 | 
请求正文
请求正文中包含结构如下的数据:
| JSON 表示法 | 
|---|
| { "deviceIds": [ string ], "changeChromeOsDeviceStatusAction": enum ( | 
| 字段 | |
|---|---|
| deviceIds[] | 
 必需。要更改的 ChromeOS 设备的 ID 列表。最多 50 个。 | 
| changeChromeOsDeviceStatusAction | 
 必需。在 ChromeOS 设备上执行的操作,以更改其状态。 | 
| deprovisionReason | 
 可选。设备取消配置的原因。如果“changeChromeOsDeviceStatusAction”设置为“CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION”,则必须提供。否则,请省略此字段。 | 
响应正文
更改一批 ChromeOS 设备状态的响应。
如果成功,响应正文将包含结构如下的数据:
| JSON 表示法 | 
|---|
| {
  "changeChromeOsDeviceStatusResults": [
    {
      object ( | 
| 字段 | |
|---|---|
| changeChromeOsDeviceStatusResults[] | 
 请求中提供的每台 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 | 
| 字段 | |
|---|---|
| deviceId | 
 ChromeOS 设备的唯一 ID。 | 
| 联合字段  
 | |
| error | 
 操作失败时表示有错误发生的结果。 | 
| response | 
 设备可以成功更改其状态。 | 
状态
Status 类型定义了适用于不同编程环境(包括 REST API 和 RPC API)的逻辑错误模型。此类型供 gRPC 使用。每条 Status 消息包含三部分数据:错误代码、错误消息和错误详细信息。
如需详细了解该错误模型及其使用方法,请参阅 API 设计指南。
| JSON 表示法 | 
|---|
| { "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } | 
| 字段 | |
|---|---|
| code | 
 状态代码,应为  | 
| message | 
 面向开发者的错误消息(应采用英语)。任何向用户显示的错误消息都应进行本地化并通过  | 
| details[] | 
 包含错误详细信息的消息列表。有一组通用的消息类型可供 API 使用。 可以包含任意类型字段的对象。附加字段  | 
ChangeChromeOsDeviceStatusSucceeded
此类型没有字段。
成功更改 ChromeOS 设备状态的响应。