REST Resource: customer.devices.chromeos.commands

Sumber daya: DirectoryChromeosdevicesCommand

Informasi mengenai 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.

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

state

enum (State)

Menunjukkan status perintah.

commandExpireTime

string (Timestamp format)

Waktu saat perintah akan berakhir masa berlakunya. Jika perangkat tidak menjalankan perintah tersebut dalam jangka waktu ini, masa berlaku perintah tersebut akan berakhir.

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

commandResult

object (DirectoryChromeosdevicesCommandResult)

Hasil dari eksekusi perintah.

payload

string

Payload yang ditentukan perintah, jika ada.

CommandType

Menetapkan jenis perintah yang harus dijalankan perangkat.

Enum
COMMAND_TYPE_UNSPECIFIED Jenis perintah belum ditetapkan.
REBOOT Boot ulang perangkat. Dapat diterbitkan untuk perangkat Kios 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 Menyetel 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 tindakan ini akan menyimpan kebijakan dan pendaftaran perangkat.
REMOTE_POWERWASH Seka 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 kepada pendaftaran otomatis atau paksa. Gunakan dengan hati-hati karena tindakan ini tidak dapat dibatalkan.
DEVICE_START_CRD_SESSION Memulai sesi Chrome Desktop Jarak Jauh.
CAPTURE_LOGS Mengambil log sistem perangkat kios. Log dapat didownload dari link downloadUrl yang ada di kolom deviceFiles pada chromeosdevices
FETCH_SUPPORT_PACKET Ambil 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 pada chromeosdevices

Negara Bagian

Menampilkan status perintah yang dikeluarkan.

Enum
STATE_UNSPECIFIED Status perintah belum ditentukan.
PENDING Perintah yang masih berlaku belum dikirim ke klien.
EXPIRED Perintah tidak dijalankan oleh klien dalam waktu yang diharapkan.
CANCELLED Perintah dibatalkan oleh admin saat dalam PENDING.
SENT_TO_CLIENT Perintah telah dikirim ke klien.
ACKED_BY_CLIENT Klien telah menjawab bahwa ia menerima perintah tersebut.
EXECUTED_BY_CLIENT Klien (belum) berhasil menjalankan perintah.

DirectoryChromeosdevicesCommandResult

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

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

errorMessage

string

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

commandResultPayload

string

Payload untuk hasil perintah. Perintah berikut merespons dengan payload:

  • DEVICE_START_CRD_SESSION: Payload adalah objek JSON string dalam bentuk: { "url": url }. URL tersebut memberikan link ke sesi Chrome Desktop Jarak Jauh.

CommandResultType

Jenis hasil perintah.

Enum
COMMAND_RESULT_TYPE_UNSPECIFIED Hasil perintah tidak ditentukan.
IGNORED Perintah diabaikan karena tidak digunakan lagi.
FAILURE Perintah tidak berhasil dijalankan.
SUCCESS Perintah berhasil dijalankan.

Metode

get

Mendapatkan data perintah dari perintah tertentu yang dikeluarkan untuk perangkat.