REST Resource: customer.devices.chromeos.commands

Resource: DirectoryChromeosdevicesCommand

Informasi terkait perintah yang dikeluarkan ke perangkat.

Representasi JSON 
{
  "commandId": string,
  "type": enum (CommandType),
  "issueTime": string,
  "state": enum (State),
  "commandExpireTime": string,
  "commandResult": {
    object (DirectoryChromeosdevicesCommandResult)
  },
  "payload": string
}
Kolom
commandId

string (int64 format)

ID unik perintah perangkat.
type

enum (CommandType)

Jenis perintah.
issueTime

string (Timestamp format)

Stempel waktu saat perintah dikeluarkan oleh admin.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
state

enum (State)

Menunjukkan status perintah.
commandExpireTime

string (Timestamp format)

Waktu saat perintah akan berakhir. Jika perangkat tidak menjalankan perintah dalam waktu ini, perintah akan berakhir.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
commandResult

object (DirectoryChromeosdevicesCommandResult)

Hasil eksekusi perintah.
payload

string

Payload yang ditentukan perintah, jika ada.

CommandType

Menetapkan jenis perintah yang harus dijalankan perangkat.

Enum
COMMAND_TYPE_UNSPECIFIED Jenis perintah tidak ditentukan.
REBOOT Boot ulang perangkat. Dapat dikeluarkan untuk perangkat Kios dan sesi tamu terkelola, serta perangkat biasa yang menjalankan ChromeOS versi 113 atau yang lebih baru.
TAKE_A_SCREENSHOT Ambil screenshot perangkat. Hanya tersedia jika perangkat dalam Mode Kios.
SET_VOLUME Menetapkan volume perangkat. Hanya dapat dikeluarkan untuk perangkat Kios dan sesi tamu terkelola.
WIPE_USERS Menghapus semua pengguna dari perangkat. Menjalankan perintah ini di perangkat akan menghapus semua data profil pengguna, tetapi akan mempertahankan kebijakan dan pendaftaran perangkat.
REMOTE_POWERWASH Menghapus data perangkat dengan melakukan power wash. Mengeksekusi perintah ini di perangkat akan menghapus semua data termasuk kebijakan pengguna, kebijakan perangkat, dan kebijakan pendaftaran. Peringatan: Tindakan ini akan mengembalikan perangkat ke setelan pabrik tanpa pendaftaran, kecuali jika perangkat tunduk pada pendaftaran paksa atau otomatis. Gunakan dengan hati-hati, karena tindakan ini tidak dapat diurungkan.
DEVICE_START_CRD_SESSION Memulai sesi Chrome Desktop Jarak Jauh.
CAPTURE_LOGS Ambil log sistem perangkat kios. Log dapat didownload dari link downloadUrl yang ada di kolom deviceFiles dari chromeosdevices
FETCH_CRD_AVAILABILITY_INFO Mengambil jenis sesi Chrome Desktop Jarak Jauh yang tersedia (pribadi atau bersama) yang dapat digunakan untuk terhubung ke perangkat dari jarak jauh.
FETCH_SUPPORT_PACKET Mengambil paket dukungan dari perangkat secara jarak jauh. Paket dukungan adalah arsip zip yang berisi berbagai log sistem dan data debug dari perangkat ChromeOS. Paket dukungan dapat didownload dari link downloadURL yang ada di kolom deviceFiles dari chromeosdevices

Negara Bagian

Menunjukkan status perintah yang dikeluarkan.

Enum
STATE_UNSPECIFIED Status perintah tidak ditentukan.
PENDING Perintah yang belum kedaluwarsa dan belum dikirim ke klien.
EXPIRED Perintah tidak dieksekusi oleh klien dalam waktu yang diharapkan.
CANCELLED Perintah dibatalkan oleh admin saat dalam status MENUNGGU TINDAKAN.
SENT_TO_CLIENT Perintah telah dikirim ke klien.
ACKED_BY_CLIENT Klien telah merespons bahwa ia menerima perintah.
EXECUTED_BY_CLIENT Klien telah (tidak) berhasil menjalankan perintah.

DirectoryChromeosdevicesCommandResult

Hasil menjalankan perintah.

Representasi JSON 
{
  "result": enum (CommandResultType),
  "executeTime": string,
  "errorMessage": string,
  "commandResultPayload": string
}
Kolom
result

enum (CommandResultType)

Hasil perintah.
executeTime

string (Timestamp format)

Waktu saat perintah dijalankan atau gagal dijalankan.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
errorMessage

string

Pesan error dengan penjelasan singkat tentang alasan perintah gagal. Hanya ada jika perintah gagal.
commandResultPayload

string

Payload untuk hasil perintah. Perintah berikut akan merespons dengan payload:

  • DEVICE_START_CRD_SESSION: Payload adalah objek JSON yang di-stringifikasi dalam bentuk: { "url": url }. URL yang diberikan ditautkan ke sesi Chrome Remote Desktop dan memerlukan autentikasi hanya menggunakan email yang terkait dengan penerbitan perintah.
  • FETCH_CRD_AVAILABILITY_INFO: Payload adalah objek JSON yang diubah menjadi string dalam bentuk: { "deviceIdleTimeInSeconds": number, "userSessionType": string, "remoteSupportAvailability": string, "remoteAccessAvailability": string }. Kolom "remoteSupportAvailability" disetel ke "AVAILABLE" jika sesi CRD shared ke perangkat tersedia. Kolom "remoteAccessAvailability" ditetapkan ke "AVAILABLE" jika sesi CRD private ke perangkat tersedia.

CommandResultType

Jenis hasil perintah.

Enum
COMMAND_RESULT_TYPE_UNSPECIFIED Hasil perintah tidak ditentukan.
IGNORED Perintah diabaikan karena sudah usang.
FAILURE Perintah tidak dapat dijalankan dengan berhasil.
SUCCESS Perintah berhasil dieksekusi.

Metode

get

 Mendapatkan data perintah untuk perintah tertentu yang dikeluarkan ke perangkat.