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)

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

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

state

enum (State)

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

commandExpireTime

string (Timestamp format)

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

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

commandResult

object (DirectoryChromeosdevicesCommandResult)

ผลของการเรียกใช้คำสั่ง

payload

string

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

CommandType

กำหนดประเภทคำสั่งที่อุปกรณ์จะต้องเรียกใช้

Enum
COMMAND_TYPE_UNSPECIFIED ไม่ได้ระบุประเภทคำสั่ง
REBOOT รีบูตอุปกรณ์ ออกให้กับคีออสก์และอุปกรณ์เซสชันผู้มาเยือนที่มีการจัดการ และอุปกรณ์ปกติที่ใช้ ChromeOS เวอร์ชัน 113 ขึ้นไปได้
TAKE_A_SCREENSHOT ถ่ายภาพหน้าจอของอุปกรณ์ ใช้ได้ก็ต่อเมื่ออุปกรณ์อยู่ในโหมดคีออสก์
SET_VOLUME ตั้งระดับเสียงของอุปกรณ์ ออกให้กับคีออสก์และอุปกรณ์เซสชันผู้เยี่ยมชมที่มีการจัดการได้เท่านั้น
WIPE_USERS ล้างข้อมูลผู้ใช้ทั้งหมดออกจากอุปกรณ์ การใช้คำสั่งนี้ในอุปกรณ์จะนำข้อมูลโปรไฟล์ผู้ใช้ทั้งหมดออก แต่จะเก็บนโยบายด้านอุปกรณ์และการลงทะเบียนเอาไว้
REMOTE_POWERWASH ล้างข้อมูลอุปกรณ์โดยทำการ Power wash การเรียกใช้คำสั่งนี้ในอุปกรณ์จะนำข้อมูลทั้งหมดออก รวมถึงนโยบายผู้ใช้ นโยบายด้านอุปกรณ์ และนโยบายการลงทะเบียน คำเตือน: การตั้งค่านี้จะเปลี่ยนอุปกรณ์กลับไปเป็นค่าเริ่มต้นเหมือนยังไม่เคยลงทะเบียนมาก่อน เว้นแต่อุปกรณ์จะถูกบังคับหรือการลงทะเบียนอัตโนมัติ โปรดใช้ด้วยความระมัดระวัง เนื่องจากเป็นการดำเนินการที่ย้อนกลับไม่ได้
DEVICE_START_CRD_SESSION เริ่มเซสชัน Chrome Remote Desktop
CAPTURE_LOGS เก็บบันทึกระบบของอุปกรณ์คีออสก์ ดาวน์โหลดบันทึกได้จากลิงก์ DownloadUrl ที่ปรากฏในช่อง deviceFiles ของ chromeosdevices
FETCH_SUPPORT_PACKET ดึงข้อมูลแพ็กเก็ตการสนับสนุนจากอุปกรณ์จากระยะไกล แพ็กเก็ตการสนับสนุนคือไฟล์เก็บถาวร Zip ที่มีบันทึกของระบบและข้อมูลการแก้ไขข้อบกพร่องต่างๆ จากอุปกรณ์ ChromeOS คุณสามารถดาวน์โหลดแพ็กเก็ตการสนับสนุนได้จากลิงก์ URL ดาวน์โหลดที่ปรากฏในช่อง 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)

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

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

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

รับข้อมูลคำสั่งตามคำสั่งเฉพาะที่ออกให้กับอุปกรณ์