REST Resource: customer.devices.chromeos.commands

ทรัพยากร: DirectoryChromeosdevicesCommand

ข้อมูลเกี่ยวกับคําสั่งที่ส่งไปยังอุปกรณ์

การแสดง JSON
{
  "commandId": string,
  "type": enum (CommandType),
  "issueTime": string,
  "state": enum (State),
  "commandExpireTime": string,
  "commandResult": {
    object (DirectoryChromeosdevicesCommandResult)
  },
  "payload": string
}
ช่อง
commandId

string (int64 format)

รหัสที่ไม่ซ้ำกันของคำสั่งอุปกรณ์

type

enum (CommandType)

ประเภทของคําสั่ง

issueTime

string (Timestamp format)

การประทับเวลาที่ผู้ดูแลระบบออกคำสั่ง

ใช้ RFC 3339 ซึ่งเอาต์พุตที่สร้างขึ้นจะเป็นรูปแบบ Z-normalized เสมอ และใช้ตัวเลขทศนิยม 0, 3, 6 หรือ 9 ระบบยังยอมรับออฟเซตอื่นๆ นอกเหนือจาก "Z" ด้วย ตัวอย่างเช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"

state

enum (State)

ระบุสถานะคําสั่ง

commandExpireTime

string (Timestamp format)

เวลาคำสั่งจะหมดอายุ หากอุปกรณ์ไม่ดำเนินการตามคำสั่งภายในเวลานี้ คำสั่งจะหมดอายุ

ใช้ RFC 3339 ซึ่งเอาต์พุตที่สร้างขึ้นจะเป็นรูปแบบ Z-normalized เสมอ และใช้ตัวเลขทศนิยม 0, 3, 6 หรือ 9 ระบบยังยอมรับออฟเซตอื่นๆ นอกเหนือจาก "Z" ด้วย ตัวอย่างเช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"

commandResult

object (DirectoryChromeosdevicesCommandResult)

ผลลัพธ์ของการดำเนินการคำสั่ง

payload

string

เพย์โหลดที่คำสั่งระบุ (หากมี)

CommandType

กำหนดประเภทคำสั่งที่อุปกรณ์ต้องดำเนินการ

Enum
COMMAND_TYPE_UNSPECIFIED ไม่ได้ระบุประเภทคําสั่ง
REBOOT รีบูตอุปกรณ์ ออกใบรับรองได้สำหรับอุปกรณ์คีออสก์และเซสชันผู้มาเยือนที่มีการจัดการ รวมถึงอุปกรณ์ทั่วไปที่ใช้ ChromeOS เวอร์ชัน 113 ขึ้นไป
TAKE_A_SCREENSHOT ถ่ายภาพหน้าจอของอุปกรณ์ ใช้ได้เฉพาะในกรณีที่อุปกรณ์อยู่ในโหมดคีออสก์
SET_VOLUME ตั้งระดับเสียงของอุปกรณ์ ออกได้เฉพาะในคีออสก์และอุปกรณ์เซสชันผู้มาเยือนที่มีการจัดการ
WIPE_USERS ล้างข้อมูลผู้ใช้ทั้งหมดออกจากอุปกรณ์ การดำเนินการตามคำสั่งนี้ในอุปกรณ์จะนำข้อมูลโปรไฟล์ผู้ใช้ทั้งหมดออก แต่จะเก็บนโยบายด้านอุปกรณ์และการลงทะเบียนไว้
REMOTE_POWERWASH ล้างข้อมูลในอุปกรณ์โดยทำการล้างข้อมูลในเครื่อง การดำเนินการตามคำสั่งนี้ในอุปกรณ์จะนำข้อมูลทั้งหมดออก ซึ่งรวมถึงนโยบายผู้ใช้ นโยบายด้านอุปกรณ์ และนโยบายการลงทะเบียน คำเตือน: การตั้งค่านี้จะเปลี่ยนอุปกรณ์กลับไปเป็นค่าเริ่มต้นเหมือนยังไม่เคยลงทะเบียนมาก่อน เว้นแต่อุปกรณ์จะอยู่ภายใต้การลงทะเบียนแบบบังคับหรือการลงทะเบียนอัตโนมัติ โปรดใช้ด้วยความระมัดระวังเนื่องจากการดำเนินการนี้จะเปลี่ยนกลับไม่ได้
DEVICE_START_CRD_SESSION เริ่มเซสชัน Chrome Remote Desktop
CAPTURE_LOGS บันทึกบันทึกของระบบในอุปกรณ์คีออสก์ คุณสามารถดาวน์โหลดบันทึกได้จากลิงก์ downloadUrl ที่มีอยู่ในช่อง deviceFiles ของ chromeosdevices
FETCH_CRD_AVAILABILITY_INFO ดึงข้อมูลซึ่งระบุความพร้อมใช้งานของ CRD (Chrome Remote Desktop) ในอุปกรณ์
FETCH_SUPPORT_PACKET ดึงข้อมูลแพ็กเกจการสนับสนุนจากอุปกรณ์จากระยะไกล แพ็กเกจการสนับสนุนคือไฟล์ ZIP ที่มีบันทึกของระบบและข้อมูลการแก้ไขข้อบกพร่องต่างๆ จากอุปกรณ์ ChromeOS คุณสามารถดาวน์โหลดแพ็กเกจการสนับสนุนได้จากลิงก์ downloadURL ที่มีอยู่ในช่อง deviceFiles ของ chromeosdevices

รัฐ

แสดงสถานะของคําสั่งที่ออก

Enum
STATE_UNSPECIFIED ไม่ได้ระบุสถานะคําสั่ง
PENDING คําสั่งที่ยังไม่หมดอายุซึ่งยังไม่ได้ส่งไปยังไคลเอ็นต์
EXPIRED ไคลเอ็นต์ไม่ได้เรียกใช้คําสั่งภายในเวลาที่กำหนด
CANCELLED ผู้ดูแลระบบยกเลิกคําสั่งขณะที่รอดำเนินการ
SENT_TO_CLIENT ระบบส่งคําสั่งไปยังไคลเอ็นต์แล้ว
ACKED_BY_CLIENT ไคลเอ็นต์ตอบกลับว่าได้คำสั่งแล้ว
EXECUTED_BY_CLIENT ลูกค้าดำเนินการตามคําสั่ง (สำเร็จหรือไม่สําเร็จ)

DirectoryChromeosdevicesCommandResult

ผลลัพธ์ของการดำเนินการคำสั่ง

การแสดง JSON
{
  "result": enum (CommandResultType),
  "executeTime": string,
  "errorMessage": string,
  "commandResultPayload": string
}
ช่อง
result

enum (CommandResultType)

ผลลัพธ์ของคำสั่ง

executeTime

string (Timestamp format)

เวลาที่มีการเรียกใช้คําสั่งหรือเรียกใช้ไม่สําเร็จ

ใช้ RFC 3339 ซึ่งเอาต์พุตที่สร้างขึ้นจะเป็นรูปแบบ Z-normalized เสมอ และใช้ตัวเลขทศนิยม 0, 3, 6 หรือ 9 ระบบยังยอมรับออฟเซตอื่นๆ นอกเหนือจาก "Z" ด้วย ตัวอย่างเช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"

errorMessage

string

ข้อความแสดงข้อผิดพลาดพร้อมคำอธิบายสั้นๆ ว่าเหตุใดคำสั่งจึงดำเนินการไม่สำเร็จ แสดงเฉพาะในกรณีที่คำสั่งไม่สำเร็จ

commandResultPayload

string

เพย์โหลดสําหรับผลลัพธ์ของคําสั่ง คำสั่งต่อไปนี้จะตอบกลับด้วยเพย์โหลด

  • DEVICE_START_CRD_SESSION: เพย์โหลดคือออบเจ็กต์ JSON ที่แปลงเป็นสตริงในรูปแบบ { "url": url } โดย URL จะให้ลิงก์ไปยังเซสชัน Chrome Remote Desktop

CommandResultType

ประเภทของผลลัพธ์คำสั่ง

Enum
COMMAND_RESULT_TYPE_UNSPECIFIED ไม่ได้ระบุผลลัพธ์ของคําสั่ง
IGNORED ระบบละเว้นคําสั่งเนื่องจากล้าสมัย
FAILURE ไม่สามารถดําเนินการตามคําสั่งได้สําเร็จ
SUCCESS ดำเนินการตามคําสั่งเรียบร้อยแล้ว

เมธอด

get

รับข้อมูลคําสั่งที่ส่งไปยังอุปกรณ์