REST Resource: customer.devices.chromeos.commands

Tài nguyên: DirectoryChromeosdevicesCommand

Thông tin về một lệnh đã được đưa ra cho một thiết bị.

Biểu diễn dưới dạng JSON
{
  "commandId": string,
  "type": enum (CommandType),
  "issueTime": string,
  "state": enum (State),
  "commandExpireTime": string,
  "commandResult": {
    object (DirectoryChromeosdevicesCommandResult)
  },
  "payload": string
}
Trường
commandId

string (int64 format)

Mã nhận dạng duy nhất của lệnh thiết bị.

type

enum (CommandType)

Loại lệnh.

issueTime

string (Timestamp format)

Dấu thời gian khi quản trị viên đưa ra lệnh.

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".

state

enum (State)

Cho biết trạng thái lệnh.

commandExpireTime

string (Timestamp format)

Thời điểm lệnh hết hạn. Nếu thiết bị không thực thi lệnh trong khoảng thời gian này, lệnh sẽ hết hạn.

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".

commandResult

object (DirectoryChromeosdevicesCommandResult)

Kết quả của quá trình thực thi lệnh.

payload

string

Trọng tải mà lệnh đã chỉ định, nếu có.

CommandType

Thiết lập loại lệnh mà thiết bị phải thực thi.

Enum
COMMAND_TYPE_UNSPECIFIED Loại lệnh chưa được chỉ định.
REBOOT Khởi động lại thiết bị. Có thể được cấp cho Kiosk và các thiết bị phiên khách được quản lý, cũng như các thiết bị thông thường chạy ChromeOS phiên bản 113 trở lên.
TAKE_A_SCREENSHOT Chụp ảnh màn hình thiết bị. Chỉ có thể sử dụng nếu thiết bị ở Chế độ Kiosk.
SET_VOLUME Đặt âm lượng của thiết bị. Chỉ có thể cấp cho thiết bị Kiosk và thiết bị có phiên khách được quản lý.
WIPE_USERS Xoá tất cả người dùng khỏi thiết bị. Việc thực thi lệnh này trong thiết bị sẽ xoá tất cả dữ liệu hồ sơ người dùng, nhưng sẽ giữ lại chính sách thiết bị và dữ liệu đăng ký.
REMOTE_POWERWASH Xoá sạch thiết bị bằng cách thực hiện quy trình xoá sạch. Việc thực thi lệnh này trong thiết bị sẽ xoá tất cả dữ liệu, bao gồm cả chính sách người dùng, chính sách thiết bị và chính sách đăng ký. Cảnh báo: Thao tác này sẽ đặt lại thiết bị về trạng thái ban đầu mà không có dữ liệu đăng ký, trừ phi thiết bị này tuân theo quy tắc đăng ký bắt buộc hoặc tự động. Hãy thận trọng khi sử dụng vì đây là một hành động không thể huỷ!
DEVICE_START_CRD_SESSION Bắt đầu một phiên Chrome Remote Desktop.
CAPTURE_LOGS Ghi lại nhật ký hệ thống của thiết bị kiosk. Bạn có thể tải nhật ký xuống từ đường liên kết downloadUrl có trong trường deviceFiles của chromeosdevices
FETCH_CRD_AVAILABILITY_INFO Tìm nạp thông tin xác định khả năng sử dụng CRD (Chrome Remote Desktop) trên thiết bị.
FETCH_SUPPORT_PACKET Tìm nạp gói hỗ trợ từ một thiết bị từ xa. Gói hỗ trợ là một tệp lưu trữ zip chứa nhiều nhật ký hệ thống và dữ liệu gỡ lỗi từ một thiết bị ChromeOS. Bạn có thể tải gói hỗ trợ xuống từ đường liên kết downloadURL có trong trường deviceFiles của chromeosdevices

Tiểu bang

Biểu thị trạng thái của lệnh đã phát hành.

Enum
STATE_UNSPECIFIED Trạng thái lệnh không được chỉ định.
PENDING Lệnh chưa hết hạn nhưng chưa được gửi đến ứng dụng.
EXPIRED Ứng dụng khách không thực thi lệnh trong thời gian dự kiến.
CANCELLED Quản trị viên đã huỷ lệnh khi lệnh đó đang ở trạng thái ĐANG CHỜ XỬ LÝ.
SENT_TO_CLIENT Lệnh đã được gửi đến ứng dụng khách.
ACKED_BY_CLIENT Ứng dụng khách đã phản hồi rằng đã nhận được lệnh.
EXECUTED_BY_CLIENT Ứng dụng đã thực thi thành công (hoặc không thành công) lệnh.

DirectoryChromeosdevicesCommandResult

Kết quả của việc thực thi một lệnh.

Biểu diễn dưới dạng JSON
{
  "result": enum (CommandResultType),
  "executeTime": string,
  "errorMessage": string,
  "commandResultPayload": string
}
Trường
result

enum (CommandResultType)

Kết quả của lệnh.

executeTime

string (Timestamp format)

Thời điểm thực thi hoặc không thực thi được lệnh.

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".

errorMessage

string

Thông báo lỗi kèm theo nội dung giải thích ngắn gọn về lý do lệnh không thành công. Chỉ xuất hiện nếu lệnh không thành công.

commandResultPayload

string

Trọng tải cho kết quả lệnh. Các lệnh sau đây phản hồi bằng một tải trọng:

  • DEVICE_START_CRD_SESSION: Trọng tải là một đối tượng JSON đã chuyển đổi thành chuỗi ở dạng: { "url": url }. URL này cung cấp đường liên kết đến phiên Chrome Remote Desktop.

CommandResultType

Loại kết quả của lệnh.

Enum
COMMAND_RESULT_TYPE_UNSPECIFIED Kết quả của lệnh không được chỉ định.
IGNORED Lệnh này đã bị bỏ qua do đã lỗi thời.
FAILURE Không thể thực thi lệnh thành công.
SUCCESS Đã thực thi thành công lệnh.

Phương thức

get

Lấy dữ liệu lệnh là một lệnh cụ thể được đưa ra cho thiết bị.