REST Resource: customer.devices.chromeos.commands

Tài nguyên: DirectoryChromeosdevicesCommand

Thông tin về một lệnh đã được gửi đến 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 riêng biệt của một lệnh thiết bị.

type

enum (CommandType)

Loại lệnh.

issueTime

string (Timestamp format)

Dấu thời gian cho biết thời điểm quản trị viên đưa ra lệnh.

Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch 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 gian hết hạn của lệnh. 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.

Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch 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

Tải trọng 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 Chưa chỉ định loại lệnh.
REBOOT Khởi động lại thiết bị. Có thể được cấp cho các thiết bị Kiosk và 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ỉ áp dụng nếu thiết bị ở Chế độ Kiosk.
SET_VOLUME Đặt âm lượng của thiết bị. Chỉ có thể được cấp cho các thiết bị ở chế độ Kiosk và phiên khách được quản lý.
WIPE_USERS Xoá tất cả người dùng khỏi thiết bị. Khi thực thi lệnh này trên thiết bị, tất cả dữ liệu hồ sơ người dùng sẽ bị xoá, nhưng chính sách thiết bị và dữ liệu đăng ký sẽ được giữ lại.
REMOTE_POWERWASH Xoá dữ liệu trên thiết bị bằng cách thực hiện thao tác xoá dữ liệu. Khi thực hiện lệnh này trên thiết bị, tất cả dữ liệu sẽ bị xoá, 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 buộc phải đăng ký hoặc tự động đăng ký. Hãy thận trọng khi sử dụng vì đây là một hành động không thể đảo ngược!
DEVICE_START_CRD_SESSION Bắt đầu một phiên Chrome Remote Desktop.
CAPTURE_LOGS Thu thập nhật ký hệ thống của một 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(các) loại phiên Chrome Remote Desktop hiện có (riêng tư hoặc dùng chung) có thể dùng để kết nối từ xa với thiết bị.
FETCH_SUPPORT_PACKET Truy xuất gói hỗ trợ 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 xác định.
PENDING Một lệnh chưa hết hạn và chưa được gửi đến ứng dụng.
EXPIRED Ứng dụng không thực thi lệnh trong thời gian dự kiến.
CANCELLED Quản trị viên huỷ lệnh trong khi lệnh ở trạng thái ĐANG CHỜ.
SENT_TO_CLIENT Lệnh đã được gửi đến ứng dụng.
ACKED_BY_CLIENT Ứng dụng khách đã phản hồi rằng ứng dụng này đã nhận được lệnh.
EXECUTED_BY_CLIENT Ứng dụng đã thực thi lệnh (không) thành công.

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 gian mà lệnh được thực thi hoặc không thực thi được.

Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch 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

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

  • DEVICE_START_CRD_SESSION: Tải trọng là một đối tượng JSON được chuyển đổi thành chuỗi ở dạng: { "url": url }. URL được cung cấp liên kết đến phiên Chrome Remote Desktop và chỉ yêu cầu xác thực bằng email được liên kết với việc phát hành lệnh.
  • FETCH_CRD_AVAILABILITY_INFO: Tải trọng là một đối tượng JSON được chuyển đổi thành chuỗi ở dạng: { "deviceIdleTimeInSeconds": number, "userSessionType": string, "remoteSupportAvailability": string, "remoteAccessAvailability": string }. Trường "remoteSupportAvailability" được đặt thành "AVAILABLE" nếu có phiên shared CRD cho thiết bị. Trường "remoteAccessAvailability" được đặt thành "AVAILABLE" nếu có phiên private CRD cho thiết bị.

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 đã bị bỏ qua do không còn được dùng.
FAILURE Không thể thực thi lệnh.
SUCCESS Lệnh đã được thực thi thành công.

Phương thức

get

Nhận dữ liệu lệnh của một lệnh cụ thể được gửi đến thiết bị.