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.

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

state

enum (State)

Menunjukkan status perintah.

commandExpireTime

string (Timestamp format)

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

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

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 belum ditentukan.
REBOOT Boot ulang perangkat. Hanya dapat diterbitkan untuk perangkat Kios dan sesi tamu terkelola.
TAKE_A_SCREENSHOT Ambil screenshot perangkat. Hanya tersedia jika perangkat dalam Mode Kios.
SET_VOLUME Menyetel volume perangkat. Hanya dapat diterbitkan untuk perangkat Kios dan sesi tamu terkelola.
WIPE_USERS Hapus total semua pengguna dari perangkat. Menjalankan perintah ini di perangkat akan menghapus semua data profil pengguna, tetapi tindakan ini 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 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 chromeosdevices
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 pada chromeosdevices

Negara Bagian

Menampilkan status perintah yang dikeluarkan.

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

DirectoryChromeosdevicesCommandResult

Hasil 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 dijalankan.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. 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 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 sudah tidak berlaku.
FAILURE Perintah tidak berhasil dijalankan.
SUCCESS Perintah berhasil dijalankan.

Metode

get

Mendapatkan data perintah perintah tertentu yang dikeluarkan ke perangkat.