שינוי הסטטוס של כמה מכשירי ChromeOS. מידע נוסף על שינוי מצב של מכשיר ChromeOS: תיקון, שינוי הייעוד של מכשירי ChromeOS או הוצאה משימוש.
בקשת HTTP
POST https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/devices/chromeos:batchChangeStatus
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
customerId |
חובה. המזהה של חשבון Google Workspace שאי אפשר לשנות. |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "deviceIds": [ string ], "changeChromeOsDeviceStatusAction": enum ( |
שדות | |
---|---|
deviceIds[] |
חובה. רשימת המזהים של מכשירי ChromeOS שצריך לשנות. מקסימום 50. |
changeChromeOsDeviceStatusAction |
חובה. הפעולה שצריך לבצע במכשיר ChromeOS כדי לשנות את הסטטוס שלו. |
deprovisionReason |
זה שינוי אופציונלי. הסיבה לביטול של ניהול ההקצאות במכשיר. יש לציין אם הערך הוא 'changeChromeOsDeviceStatusAction' מוגדרת כ-'CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION'. אחרת, צריך להשמיט את השדה הזה. |
גוף התשובה
התגובה לשינוי הסטטוס של כמה מכשירי ChromeOS.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"changeChromeOsDeviceStatusResults": [
{
object ( |
שדות | |
---|---|
changeChromeOsDeviceStatusResults[] |
התוצאות של כל אחד ממכשירי ChromeOS שצוינו בבקשה. |
היקפי ההרשאות
נדרש היקף ההרשאות הבא של OAuth:
https://www.googleapis.com/auth/admin.directory.device.chromeos
מידע נוסף זמין במדריך להרשאות.
ChangeChromeOsDeviceStatusAction
הפעולה שיש לבצע כדי לשנות את הסטטוס של מכשיר ChromeOS.
טיפוסים בני מנייה (enum) | |
---|---|
CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_UNSPECIFIED |
ערך ברירת המחדל. הערך לא בשימוש. |
CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION |
מבטל את ניהול ההקצאות של מכשיר ChromeOS. אם יש לך מכשירי ChromeOS שלא נמצאים יותר בשימוש בארגון שלך, צריך לבטל את ניהול ההקצאות שלהם כדי לא לנהל אותם יותר. כשמבטלים את ניהול ההקצאות של המכשיר, מסירים את כל כללי המדיניות שהיו במכשיר, וגם את המדפסות ברמת המכשיר ואת האפשרות להשתמש במכשיר כקיוסק. בהתאם לשדרוג שמשויך למכשיר, הפעולה הזו עשויה לשחרר את הרישיון בחזרה למאגר הרישיונות. שמאפשרת להשתמש ברישיון במכשיר אחר. |
CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DISABLE |
ההגדרה משביתה מכשיר ChromeOS. אפשר להשתמש בפעולה הזו אם משתמש מאבד את המכשיר או נגנב, כך שהמכשיר עדיין מנוהל, כך שהמכשיר עדיין יהיה מנוהל, אבל אף אחד לא יוכל להשתמש בו. בהתאם לשדרוג שמשויך למכשיר, הפעולה הזו עשויה לשחרר את הרישיון בחזרה למאגר הרישיונות. שמאפשרת להשתמש ברישיון במכשיר אחר. |
CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_REENABLE |
מפעילה מחדש את השימוש במכשיר ChromeOS לאחר השבתה. תפעיל מחדש את המכשיר אם הוא לא יאבד או ישוחזר. כך ניתן יהיה להשתמש שוב במכשיר. בהתאם לשדרוג שמשויך למכשיר, ייתכן שיהיה צורך ברישיון אחד ממאגר הרישיונות. כלומר, אם אין מספיק רישיונות זמינים, הפעולה תיכשל. |
ChangeChromeOsDeviceStatusResult
תוצאה של פעולת שינוי מצב במכשיר ChromeOS אחד.
ייצוג JSON |
---|
{ "deviceId": string, // Union field |
שדות | |
---|---|
deviceId |
המזהה הייחודי של מכשיר ה-ChromeOS. |
שדה איחוד
|
|
error |
תוצאת השגיאה של הפעולה במקרה של כשל. |
response |
המכשיר יכול לשנות את הסטטוס שלו בהצלחה. |
סטטוס
הסוג Status
מגדיר מודל שגיאות לוגי שמתאים לסביבות תכנות שונות, כולל ממשקי API ל-REST וממשקי API ל-RPC. הוא נמצא בשימוש של gRPC. כל הודעת Status
מכילה שלושה נתונים: קוד שגיאה, הודעת שגיאה ופרטי שגיאה.
במדריך לעיצוב API אפשר לקרוא מידע נוסף על מודל השגיאות הזה ולהבין איך לעבוד איתו.
ייצוג JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
שדות | |
---|---|
code |
קוד הסטטוס, שצריך להיות ערך enum של |
message |
הודעת שגיאה שמיועדת למפתחים וצריכה להיות באנגלית. כל הודעת שגיאה שמוצגת למשתמשים צריכה להיות מותאמת לשוק המקומי ולשלוח אותה בשדה |
details[] |
רשימה של הודעות שמכילות את פרטי השגיאה. יש כמה סוגים של הודעות שאפשר להשתמש בהם בממשקי API. אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף |
ChangeChromeOsDeviceStatusSucceeded
אין שדות בסוג הזה.
תגובה לשינוי הסטטוס של מכשיר ChromeOS.