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' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

state

enum (State)

מציין את מצב הפקודה.

commandExpireTime

string (Timestamp format)

השעה שבה יפוג תוקף הפקודה. אם המכשיר לא יריץ את הפקודה בפרק הזמן הזה, התוקף שלה יפוג.

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

commandResult

object (DirectoryChromeosdevicesCommandResult)

התוצאה של ביצוע הפקודה.

payload

string

המטען הייעודי (Payload) שהפקודה מציינת, אם יש כזה.

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_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' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

errorMessage

string

הודעת השגיאה עם הסבר קצר למה הפקודה נכשלה. הצגה רק אם הפקודה נכשלה.

commandResultPayload

string

המטען הייעודי (payload) של תוצאת הפקודה. הפקודות הבאות מגיבות עם מטען ייעודי (payload):

  • DEVICE_START_CRD_SESSION: המטען הייעודי (Payload) הוא אובייקט JSON בפורמט מחרוזת בפורמט: { "url": url }. כתובת ה-URL מספקת קישור לסשן של Chrome Remote Desktop.

CommandResultType

הסוג של תוצאת הפקודה.

טיפוסים בני מנייה (enum)
COMMAND_RESULT_TYPE_UNSPECIFIED תוצאת הפקודה לא צוינה.
IGNORED המערכת התעלמה מהפקודה כמיושנת.
FAILURE לא ניתן היה לבצע את הפקודה הזו.
SUCCESS הפקודה בוצעה בהצלחה.

שיטות

get

קבלת נתוני פקודה של פקודה ספציפית שמונפקת למכשיר.