更改一批 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 设备状态的响应。