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, dengan output yang dihasilkan akan selalu dinormalisasi Z dan menggunakan digit pecahan 0, 3, 6, atau 9. 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 masa berlakunya. Jika perangkat tidak menjalankan perintah dalam waktu ini, perintah akan berakhir masa berlakunya.

Menggunakan RFC 3339, dengan output yang dihasilkan akan selalu dinormalisasi Z dan menggunakan digit pecahan 0, 3, 6, atau 9. 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 dieksekusi perangkat.

Enum
COMMAND_TYPE_UNSPECIFIED Jenis perintah tidak ditentukan.
REBOOT Boot ulang perangkat. Dapat diterbitkan ke perangkat Kiosk dan sesi tamu terkelola, serta perangkat reguler 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 diterbitkan ke perangkat Kios dan sesi tamu terkelola.
WIPE_USERS Menghapus total 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 total perangkat dengan melakukan power wash. Menjalankan 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 informasi yang menentukan ketersediaan CRD (Chrome Desktop Jarak Jauh) di perangkat.
FETCH_SUPPORT_PACKET Mengambil paket dukungan dari perangkat dari 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

Merepresentasikan status perintah yang dikeluarkan.

Enum
STATE_UNSPECIFIED Status perintah tidak ditentukan.
PENDING Perintah yang belum habis masa berlakunya dan belum dikirim ke klien.
EXPIRED Perintah tidak dijalankan oleh klien dalam waktu yang diharapkan.
CANCELLED Perintah dibatalkan oleh admin saat dalam status TERTUNDA.
SENT_TO_CLIENT Perintah telah dikirim ke klien.
ACKED_BY_CLIENT Klien telah merespons bahwa klien telah menerima perintah.
EXECUTED_BY_CLIENT Klien berhasil (tidak) mengeksekusi perintah.

DirectoryChromeosdevicesCommandResult

Hasil dari eksekusi 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 dieksekusi atau gagal dieksekusi.

Menggunakan RFC 3339, dengan output yang dihasilkan akan selalu dinormalisasi Z dan menggunakan digit pecahan 0, 3, 6, atau 9. 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 kegagalan perintah. 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-string dalam bentuk: { "url": url }. URL menyediakan link ke sesi Desktop Jarak Jauh Chrome.

CommandResultType

Jenis hasil perintah.

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

Metode

get

 Mendapatkan data perintah perintah tertentu yang dikeluarkan ke perangkat.