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 เสมอ และใช้ตัวเลขเศษส่วน 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 เสมอ และใช้ตัวเลขเศษส่วน 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 ล้างข้อมูลในอุปกรณ์โดยการล้างข้อมูลด้วย Powerwash การเรียกใช้คำสั่งนี้ในอุปกรณ์จะนำข้อมูลทั้งหมดออก ซึ่งรวมถึงนโยบายผู้ใช้ นโยบายอุปกรณ์ และนโยบายการลงทะเบียน คำเตือน: การดำเนินการนี้จะเปลี่ยนอุปกรณ์กลับไปเป็นค่าเริ่มต้นเหมือนยังไม่เคยลงทะเบียนมาก่อน เว้นแต่อุปกรณ์จะอยู่ภายใต้การบังคับการลงทะเบียนหรือการลงทะเบียนอัตโนมัติ โปรดใช้ด้วยความระมัดระวัง เนื่องจากเป็นการดำเนินการที่ย้อนกลับไม่ได้
DEVICE_START_CRD_SESSION เริ่มเซสชัน Chrome Remote Desktop
CAPTURE_LOGS เก็บบันทึกของระบบของอุปกรณ์คีออสก์ คุณดาวน์โหลดบันทึกได้จากลิงก์ downloadUrl ในฟิลด์ deviceFiles ของ chromeosdevices
FETCH_CRD_AVAILABILITY_INFO ดึงข้อมูลประเภทเซสชัน 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 เสมอ และใช้ตัวเลขเศษส่วน 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 และต้องมีการตรวจสอบสิทธิ์โดยใช้เฉพาะ email ที่เชื่อมโยงกับการออกคำสั่ง
  • FETCH_CRD_AVAILABILITY_INFO: เพย์โหลดคือออบเจ็กต์ JSON ที่แปลงเป็นสตริงในรูปแบบ { "deviceIdleTimeInSeconds": number, "userSessionType": string, "remoteSupportAvailability": string, "remoteAccessAvailability": string } โดยฟิลด์ "remoteSupportAvailability" จะตั้งค่าเป็น "AVAILABLE" หากshared เซสชัน CRD ไปยังอุปกรณ์พร้อมใช้งาน ฟิลด์ "remoteAccessAvailability" จะตั้งค่าเป็น "AVAILABLE" หากเซสชัน private CRD ไปยังอุปกรณ์พร้อมใช้งาน

CommandResultType

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

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

เมธอด

get

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