Method: customer.devices.chromeos.issueCommand

向设备发出要执行的命令。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
customerId

string

不可变。Google Workspace 账号的 ID。
deviceId

string

不可变。ChromeOS 设备的 ID。

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "commandType": enum (CommandType),
  "payload": string
}
字段
commandType

enum (CommandType)

命令的类型。
payload

string

命令的载荷，仅当命令支持时才提供。以下命令支持添加载荷：

  • SET_VOLUME：载荷是字符串化的 JSON 对象，格式为：{ "volume": 50 }。音量必须是 [0,100] 范围内的整数。
  • DEVICE_START_CRD_SESSION：载荷可以选择性地采用字符串化 JSON 对象的形式：{ "ackedUserPresence": true, "crdSessionType": string }。ackedUserPresence 是一个布尔值。默认情况下，ackedUserPresence 设置为 false。如需为有效设备启动 Chrome 远程桌面会话，请将 ackedUserPresence 设置为 true。crdSessionType 只能从值 private（授予远程管理员对 ChromeOS 设备的独占控制权）或 shared（允许管理员和本地用户共享对 ChromeOS 设备的控制权）中进行选择。如果未设置，则 crdSessionType 默认为 shared。FETCH_CRD_AVAILABILITY_INFO 命令可用于确定设备上可用的会话类型。
  • REBOOT：载荷是一个字符串化的 JSON 对象，格式为：{ "user_session_delay_seconds": 300 }。user_session_delay_seconds 是在用户登录时重新启动设备之前等待的秒数。必须是 [0,300] 范围内的整数。如果重新启动时没有载荷，则默认延迟时间为 0。注意：这仅适用于实际用户（包括访客）已登录的情况。如果设备处于登录界面或自助服务终端模式，则系统不会遵循该值，而是会立即重新启动设备。
  • FETCH_SUPPORT_PACKET：载荷可以选择性地采用字符串化的 JSON 对象形式：{"supportPacketDetails":{ "issueCaseId": optional_support_case_id_string, "issueDescription": optional_issue_description_string, "requestedDataCollectors": [<comma-separated list of data_collector_enums integer values>]}}
    可用的 data_collector_enums 列表如下：Chrome 系统信息 (1)、崩溃 ID (2)、内存详细信息 (3)、界面层次结构 (4)、其他 ChromeOS 平台日志 (5)、设备事件 (6)、Intel WiFi NIC 调试转储 (7)、触控事件 (8)、Lacros (9)、Lacros 系统信息 (10)、ChromeOS Flex 日志 (11)、DBus 详细信息 (12)、ChromeOS 网络路由 (13)、ChromeOS Shill（连接管理器）日志 (14)、政策 (15)、ChromeOS 系统状态和日志 (16)、ChromeOS 系统日志 (17)、ChromeOS Chrome 用户日志 (18)、ChromeOS 蓝牙 (19)、ChromeOS 已连接的输入设备 (20)、ChromeOS 流量计数器 (21)、ChromeOS 虚拟键盘 (22)、ChromeOS 网络健康状况 (23)。
    如需了解详情，请参阅帮助文章。

响应正文

用于发出命令的响应。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "commandId": string
}
字段
commandId

string (int64 format)

已发出命令的唯一 ID，用于检索命令状态。

授权范围

需要以下 OAuth 范围：

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

如需了解详情，请参阅授权指南。