REST Resource: projects.locations.instances

משאב: מכונה

ההגדרה של מכונת ה-notebook.

ייצוג ב-JSON
{
  "name": string,
  "postStartupScript": string,
  "proxyUri": string,
  "instanceOwners": [
    string
  ],
  "serviceAccount": string,
  "serviceAccountScopes": [
    string
  ],
  "machineType": string,
  "acceleratorConfig": {
    object (AcceleratorConfig)
  },
  "state": enum (State),
  "installGpuDriver": boolean,
  "customGpuDriverPath": string,
  "bootDiskType": enum (DiskType),
  "bootDiskSizeGb": string,
  "dataDiskType": enum (DiskType),
  "dataDiskSizeGb": string,
  "noRemoveDataDisk": boolean,
  "diskEncryption": enum (DiskEncryption),
  "kmsKey": string,
  "disks": [
    {
      object (Disk)
    }
  ],
  "shieldedInstanceConfig": {
    object (ShieldedInstanceConfig)
  },
  "noPublicIp": boolean,
  "noProxyAccess": boolean,
  "network": string,
  "subnet": string,
  "labels": {
    string: string,
    ...
  },
  "metadata": {
    string: string,
    ...
  },
  "tags": [
    string
  ],
  "upgradeHistory": [
    {
      object (UpgradeHistoryEntry)
    }
  ],
  "nicType": enum (NicType),
  "reservationAffinity": {
    object (ReservationAffinity)
  },
  "creator": string,
  "canIpForward": boolean,
  "createTime": string,
  "updateTime": string,
  "instanceMigrationEligibility": {
    object (InstanceMigrationEligibility)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "vmImage": {
    object (VmImage)
  },
  "containerImage": {
    object (ContainerImage)
  }
  // End of mutually exclusive fields.
  "migrated": boolean
}
שדות
name

string

פלט בלבד. השם של מופע ה-Notebook הזה. פורמט: projects/{projectId}/locations/{location}/instances/{instanceId}

postStartupScript

string

נתיב לסקריפט Bash שמופעל אוטומטית אחרי שמפעילים באופן מלא את מופע המחברת. הנתיב צריך להיות כתובת URL או נתיב Cloud Storage ‏ (gs://path-to-file/file-name).

proxyUri

string

פלט בלבד. נקודת הקצה של ה-proxy שמשמשת לגישה לנוטבוק של Jupyter.

instanceOwners[]

string

קלט בלבד. הבעלים של המופע הזה אחרי שהוא נוצר. פורמט: alias@example.com

בשלב הזה יש תמיכה רק בבעלים אחד. אם לא מציינים, כל המשתמשים בחשבון השירות של המכונה הווירטואלית יכולים להשתמש במכונה.

serviceAccount

string

חשבון השירות במכונה הזו, שנותן גישה לשירותים אחרים של Google Cloud. אפשר להשתמש בכל חשבון שירות באותו פרויקט, אבל צריך לקבל הרשאת משתמש בחשבון השירות כדי להשתמש במופע.

אם לא מציינים חשבון שירות, המערכת משתמשת בחשבון השירות שמוגדר כברירת מחדל ב-Compute Engine.

serviceAccountScopes[]

string

זה שינוי אופציונלי. כתובות ה-URI של היקפי חשבון השירות שייכללו במכונות של Compute Engine.

אם לא מציינים היקפים, מוגדרים ההיקפים הבאים: ‫- https://www.googleapis.com/auth/cloud-platform ‫- https://www.googleapis.com/auth/userinfo.email אם לא משתמשים בהיקפים שמוגדרים כברירת מחדל, צריך לפחות את ההיקף: https://www.googleapis.com/auth/compute

machineType

string

חובה. סוג המכונה של Compute Engine של המופע הזה.

acceleratorConfig

object (AcceleratorConfig)

שיפור המהירות באמצעות חומרה שנעשה בו שימוש במופע הזה. אם אתם משתמשים במאיצים, ודאו שההגדרה שלכם כוללת מספיק מעבדי vCPU וזיכרון כדי לתמוך ב-machineType שבחרתם.

state

enum (State)

פלט בלבד. המצב של המופע הזה.

installGpuDriver

boolean

האם משתמש הקצה מאשר ל-Google Cloud להתקין מנהל התקן של GPU במופע הזה. אם השדה הזה ריק או מוגדר כ-False, מנהל ההתקן של ה-GPU לא יותקן. רלוונטי רק למכונות עם GPU.

customGpuDriverPath

string

מציינים נתיב מותאם אישית ב-Cloud Storage שבו מאוחסן מנהל ההתקן של ה-GPU. אם לא מציינים, המערכת תבחר אוטומטית מתוך מנהלי התקנים רשמיים של GPU.

bootDiskType

enum (DiskType)

קלט בלבד. סוג דיסק האתחול שמצורף למכונה הזו. ברירת המחדל היא דיסק מתמיד סטנדרטי (PD_STANDARD).

bootDiskSizeGb

string (int64 format)

קלט בלבד. גודל דיסק האתחול ב-GB שמצורף למופע הזה, עד למקסימום של 64,000GB ‏ (64TB). הערך המינימלי המומלץ הוא 100GB. אם לא מציינים ערך, ברירת המחדל היא 100.

dataDiskType

enum (DiskType)

קלט בלבד. סוג דיסק הנתונים שמחובר למכונה הזו. ברירת המחדל היא דיסק מתמיד סטנדרטי (PD_STANDARD).

dataDiskSizeGb

string (int64 format)

קלט בלבד. גודל דיסק הנתונים ב-GB שמחובר למופע הזה, עד למקסימום של 64,000GB ‏ (64TB). אתם יכולים לבחור את הגודל של דיסק הנתונים בהתאם לגודל של מחברות ונתונים. אם לא מציינים ערך, ברירת המחדל היא 100.

noRemoveDataDisk

boolean

קלט בלבד. אם הערך הוא true, דיסק הנתונים לא יימחק אוטומטית כשמוחקים את המופע.

diskEncryption

enum (DiskEncryption)

קלט בלבד. שיטת הצפנת הדיסק שמשמשת בדיסקים של האתחול והנתונים, ברירת המחדל היא GMEK.

kmsKey

string

קלט בלבד. מפתח KMS שמשמש להצפנת הדיסקים. רלוונטי רק אם diskEncryption הוא CMEK. פורמט: projects/{projectId}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

מידע נוסף על שימוש במפתחות הצפנה משלכם

disks[]

object (Disk)

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

shieldedInstanceConfig

object (ShieldedInstanceConfig)

זה שינוי אופציונלי. הגדרה של מכונה וירטואלית מוגנת. תמונות שמשתמשות בתכונות נתמכות של מכונות וירטואליות מוגנות.

noPublicIp

boolean

אם הערך הוא True, לא תוקצה כתובת IP חיצונית למופע הזה.

noProxyAccess

boolean

אם הערך הוא True, מופע המחברת לא יירשם בשרת ה-proxy.

network

string

השם של ה-VPC שבו נמצאת המכונה הזו. פורמט: projects/{projectId}/global/networks/{network_id}

subnet

string

השם של רשת המשנה שהמופע הזה נמצא בה. פורמט: projects/{projectId}/regions/{region}/subnetworks/{subnetwork_id}

labels

map (key: string, value: string)

תוויות להחלה על המופע הזה. אפשר לשנות את התוויות האלה בהמשך באמצעות השיטה setLabels.

אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

metadata

map (key: string, value: string)

מטא-נתונים בהתאמה אישית להחלה על המופע הזה. לדוגמה, כדי לציין קטגוריה של Cloud Storage לגיבוי אוטומטי, אפשר להשתמש בתג המטא-נתונים gcs-data-bucket. פורמט: "--metadata=gcs-data-bucket=BUCKET"

אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

tags[]

string

זה שינוי אופציונלי. תגי הרשת של Compute Engine שרוצים להוסיף לזמן הריצה (ראו הוספת תגי רשת).

upgradeHistory[]

object (UpgradeHistoryEntry)

היסטוריית השדרוגים של המכונה הזו.

nicType

enum (NicType)

זה שינוי אופציונלי. סוג ה-vNIC שבו יש להשתמש בממשק הזה. יכול להיות שמדובר ב-gVNIC או ב-VirtioNet.

reservationAffinity

object (ReservationAffinity)

זה שינוי אופציונלי. הזיקה האופציונלית להזמנה. הגדרת השדה הזה תחיל את הזמנת המחשוב האזורי שצוינה על מופע המחברת הזה.

creator

string

פלט בלבד. כתובת האימייל של הישות ששלחה את הבקשה המקורית של instances.create.

canIpForward

boolean

זה שינוי אופציונלי. דגל להפעלה או להשבתה של העברת IP, ברירת המחדל היא false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward

createTime

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".

updateTime

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".

instanceMigrationEligibility

object (InstanceMigrationEligibility)

פלט בלבד. בודק את ההיתכנות של מעבר מ-UmN ל-WbI.

סוג הסביבה, שיכול להיות אחת מהאפשרויות הבאות: קובץ אימג' של מכונה וירטואלית או קובץ אימג' של קונטיינר. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
vmImage

object (VmImage)

משתמשים בתמונה של מכונה וירטואלית ב-Compute Engine כדי להפעיל את מחברת Jupyter.

containerImage

object (ContainerImage)

משתמשים בקובץ אימג' של קונטיינר כדי להפעיל את מופע הנוטבוק.

סוף השדות הבלעדיים.
migrated

boolean

פלט בלבד. ערך בוליאני שמציין אם ה-notebook הזה הועבר למופע של Workbench

AcceleratorConfig

הגדרה של שיפור המהירות באמצעות חומרה. חשוב לזכור שלא כל השילובים של type ו-coreCount הם תקינים. כדי למצוא שילוב תקין, אפשר לעיין במאמר בנושא GPUs on Compute Engine. אין תמיכה ב-TPU.

ייצוג ב-JSON
{
  "type": enum (AcceleratorType),
  "coreCount": string
}
שדות
type

enum (AcceleratorType)

סוג המאיץ.

coreCount

string (int64 format)

מספר ליבות המעבד של המאיץ הזה.

AcceleratorType

הגדרה של סוגי מאיצי החומרה שאפשר להשתמש בהם במופע הזה.

טיפוסים בני מנייה (enum)
ACCELERATOR_TYPE_UNSPECIFIED לא צוין סוג המאיץ.
NVIDIA_TESLA_K80 סוג המאיץ הוא Nvidia Tesla K80.
NVIDIA_TESLA_P100 סוג המאיץ הוא Nvidia Tesla P100.
NVIDIA_TESLA_V100 סוג המאיץ הוא Nvidia Tesla V100.
NVIDIA_TESLA_P4 סוג המאיץ הוא Nvidia Tesla P4.
NVIDIA_TESLA_T4 סוג המאיץ הוא Nvidia Tesla T4.
NVIDIA_TESLA_A100 סוג המאיץ הוא Nvidia Tesla A100.
NVIDIA_L4 סוג המאיץ הוא Nvidia Tesla L4.
NVIDIA_A100_80GB סוג המאיץ הוא Nvidia Tesla A100 80GB.
NVIDIA_TESLA_T4_VWS סוג המאיץ הוא NVIDIA Tesla T4 Virtual Workstations.
NVIDIA_TESLA_P100_VWS סוג המאיץ הוא NVIDIA Tesla P100 Virtual Workstations.
NVIDIA_TESLA_P4_VWS סוג המאיץ הוא NVIDIA Tesla P4 Virtual Workstations.
NVIDIA_H100_80GB סוג המאיץ הוא NVIDIA H100 80GB.
NVIDIA_H100_MEGA_80GB סוג המאיץ הוא NVIDIA H100 Mega 80GB.
TPU_V2 (בקרוב) סוג המאיץ הוא TPU V2.
TPU_V3 (בקרוב) סוג המאיץ הוא TPU V3.

מדינה

ההגדרה של המצבים של המופע הזה.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED לא צוין מצב.
STARTING לוגיקת הבקרה מתחילה את המופע.
PROVISIONING הלוגיקה של אמצעי הבקרה היא התקנת מסגרות נדרשות ורישום המופע בשרת ה-proxy של המחברת
ACTIVE המופע פועל.
STOPPING לוגיקת הבקרה מפסיקה את המכונה.
STOPPED המכונה הופסקה.
DELETED המכונה נמחקת.
UPGRADING המופע עובר שדרוג.
INITIALIZING המופע נוצר.
REGISTERING המופע נרשם.
SUSPENDING המופע מושעה.
SUSPENDED המכונה מושעית.

DiskType

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

טיפוסים בני מנייה (enum)
DISK_TYPE_UNSPECIFIED לא הוגדר סוג הדיסק.
PD_STANDARD סוג של דיסק מתמיד סטנדרטי.
PD_SSD סוג הדיסק המתמיד שמבוסס על SSD.
PD_BALANCED סוג דיסק אחסון מתמיד מאוזן.
PD_EXTREME סוג דיסק אחסון מתמיד מסוג Extreme.

DiskEncryption

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

טיפוסים בני מנייה (enum)
DISK_ENCRYPTION_UNSPECIFIED לא צוינה הצפנת דיסק.
GMEK שימוש במפתחות הצפנה בניהול Google להצפנת דיסק האתחול.
CMEK שימוש במפתחות הצפנה בניהול הלקוח כדי להצפין את דיסק האתחול.

דיסק

משאב דיסק שמצורף למופע.

ייצוג ב-JSON
{
  "autoDelete": boolean,
  "boot": boolean,
  "deviceName": string,
  "diskSizeGb": string,
  "guestOsFeatures": [
    {
      object (GuestOsFeature)
    }
  ],
  "index": string,
  "interface": string,
  "kind": string,
  "licenses": [
    string
  ],
  "mode": string,
  "source": string,
  "type": string
}
שדות
autoDelete

boolean

ההגדרה הזו מציינת אם הדיסק יימחק אוטומטית כשהאירוע יימחק (אבל לא כשהדיסק מנותק מהאירוע).

boot

boolean

מציין שזה דיסק אתחול. המכונה הווירטואלית תשתמש במחיצה הראשונה של הדיסק עבור מערכת הקבצים הבסיסית שלה.

deviceName

string

מציין שם ייחודי למכשיר לבחירתכם, שמופיע בעץ /dev/disk/by-id/google-* של מערכת הפעלה מסוג Linux שפועלת בתוך המופע. אפשר להשתמש בשם הזה כדי להפנות למכשיר לצורך הרכבה, שינוי גודל וכו', מתוך המופע.

אם לא מציינים שם, השרת בוחר שם מכשיר שמוגדר כברירת מחדל להחלה על הדיסק הזה, בתבנית persistent-disk-x, כאשר x הוא מספר שמוקצה על ידי Google Compute Engine.השדה הזה רלוונטי רק לדיסקים קבועים.

diskSizeGb

string (int64 format)

מציין את גודל הדיסק ב-GB בבסיס 2.

guestOsFeatures[]

object (GuestOsFeature)

מציינת רשימה של תכונות להפעלה במערכת ההפעלה של האורח. רלוונטי רק לתמונות שניתן להפעיל מהן את המחשב. במאמר בנושא הפעלת תכונות של מערכת הפעלה אורחת מופיעה רשימה של האפשרויות הזמינות.

index

string (int64 format)

אינדקס מבוסס-אפס של הדיסק הזה, כאשר 0 שמור לדיסק האתחול. אם יש הרבה דיסקים שמצורפים למופע, לכל דיסק יהיה מספר אינדקס ייחודי.

interface

string

מציין את ממשק הדיסק שבו יש להשתמש כדי לצרף את הדיסק הזה, שהוא SCSI או NVME. ברירת המחדל היא SCSI. תמיד צריך להשתמש ב-SCSI בדיסקים מתמידים, והבקשה תיכשל אם תנסו לצרף דיסק מתמיד בכל פורמט אחר מלבד SCSI. אפשר להשתמש ב-NVME או ב-SCSI עבור כונני SSD מקומיים. למידע על מאפייני הביצועים של SCSI over NVMe, אפשר לעיין במאמר בנושא ביצועים של SSD מקומי. הערכים האפשריים:

  • NVME
  • SCSI
kind

string

סוג המשאב. תמיד מחשבים את הערך של ‎#attachedDisk‎ עבור דיסקים שמצורפים.

licenses[]

string

רשימה של רישיונות שגלויים לכולם. שמור לשימוש של Google. רישיון מייצג נתוני חיוב ונתוני שימוש מצטברים לתמונות ציבוריות ולתמונות מ-Marketplace.

mode

string

המצב שבו הדיסק הזה מצורף, READ_WRITE או READ_ONLY. אם לא מציינים את המצב, ברירת המחדל היא לצרף את הדיסק במצב READ_WRITE. הערכים האפשריים:

  • READ_ONLY
  • READ_WRITE
source

string

מציין כתובת URL תקינה, חלקית או מלאה, למשאב קיים של Persistent Disk.

type

string

מציין את סוג הדיסק, SCRATCH או PERSISTENT. הערכים האפשריים:

  • PERSISTENT
  • SCRATCH

GuestOsFeature

תכונות של מערכת הפעלה אורחת לדיסק האתחול.

ייצוג ב-JSON
{
  "type": string
}
שדות
type

string

המזהה של תכונה נתמכת. במאמר בנושא הפעלת תכונות של מערכת הפעלה אורחת מופיעה רשימה של האפשרויות הזמינות. הערכים האפשריים:

  • FEATURE_TYPE_UNSPECIFIED
  • MULTI_IP_SUBNET
  • SECURE_BOOT
  • UEFI_COMPATIBLE
  • VIRTIO_SCSI_MULTIQUEUE
  • WINDOWS

ShieldedInstanceConfig

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

ייצוג ב-JSON
{
  "enableSecureBoot": boolean,
  "enableVtpm": boolean,
  "enableIntegrityMonitoring": boolean
}
שדות
enableSecureBoot

boolean

המאפיין הזה מגדיר אם האתחול המאובטח מופעל במופע.

ההפעלה המאובטחת עוזרת לוודא שבמערכת פועלת רק תוכנה מקורית. היא עושה זאת באמצעות אימות החתימה הדיגיטלית של כל רכיבי האתחול, ועצירת תהליך האתחול אם אימות החתימה נכשל. ההגדרה מושבתת כברירת מחדל.

enableVtpm

boolean

ההגדרה קובעת אם ה-vTPM מופעל במופע. מופעל כברירת מחדל.

enableIntegrityMonitoring

boolean

ההגדרה קובעת אם המעקב אחר התקינות מופעל במופע.

האפשרות הזו מאפשרת מעקב ואימות של תקינות האתחול של המופע. האימות מתבצע בהשוואה לערך הבסיסי של מדיניות השלמות. ה-Baseline הזה נגזר בהתחלה מקובץ האימג' לאתחול שמהימן באופן מרומז כשהמופע נוצר. מופעל כברירת מחדל.

UpgradeHistoryEntry

הערך של היסטוריית השדרוגים של תמונות מכונות וירטואליות.

ייצוג ב-JSON
{
  "snapshot": string,
  "vmImage": string,
  "containerImage": string,
  "framework": string,
  "version": string,
  "state": enum (State),
  "createTime": string,
  "targetImage": string,
  "action": enum (Action),
  "targetVersion": string
}
שדות
snapshot

string

קובץ ה-snapshot של דיסק האתחול של מופע ה-notebook הזה לפני השדרוג.

vmImage

string

תמונת המכונה הווירטואלית לפני שדרוג המופע הזה.

containerImage

string

קובץ אימג' של קונטיינר לפני שדרוג המופע הזה.

framework

string

המסגרת של מכונת ה-notebook.

version

string

הגרסה של מופע ה-notebook לפני השדרוג הזה.

state

enum (State)

המצב של רשומת היסטוריית השדרוג של המופע הזה.

createTime

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".

targetImage
(deprecated)

string

תמונת VM של היעד. פורמט: ainotebooks-vm/project/image-name/name

action

enum (Action)

פעולה. חזרה לגרסה קודמת או שדרוג.

targetVersion

string

גרסת המכונה הווירטואלית לטירגוט, כמו m63.

מדינה

ההגדרה של המצבים של רשומה בהיסטוריית השדרוגים.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED לא צוין מצב.
STARTED השדרוג של המופע מתחיל.
SUCCEEDED השדרוג של המופע בוצע בהצלחה.
FAILED שדרוג המופע נכשל.

פעולה

ההגדרה של הפעולות ברשומה הזו בהיסטוריית השדרוגים.

טיפוסים בני מנייה (enum)
ACTION_UNSPECIFIED לא צוינה פעולה.
UPGRADE שדרוג.
ROLLBACK רולבק.

NicType

סוג מנהל ההתקן של ה-vNIC. ברירת המחדל צריכה להיות UNSPECIFIED_NIC_TYPE.

טיפוסים בני מנייה (enum)
UNSPECIFIED_NIC_TYPE לא צוין סוג.
VIRTIO_NET VIRTIO
GVNIC GVNIC

ReservationAffinity

העדפה להזמנה לצריכת הזמנה אזורית.

ייצוג ב-JSON
{
  "consumeReservationType": enum (Type),
  "key": string,
  "values": [
    string
  ]
}
שדות
consumeReservationType

enum (Type)

זה שינוי אופציונלי. סוג ההזמנה לניצול

key

string

זה שינוי אופציונלי. הערך הזה תואם למפתח התווית של משאב ההזמנה.

values[]

string

זה שינוי אופציונלי. הערך הזה תואם לערכי התוויות של משאב ההזמנה.

סוג

מציין אם לצרוך קיבולת ממקום שמור או לא.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED סוג ברירת המחדל.
NO_RESERVATION לא צורכים מקיבולת שהוקצתה.
ANY_RESERVATION לצרוך כל מקום שמור שזמין.
SPECIFIC_RESERVATION השימוש צריך להיות מתוך הזמנה ספציפית. חובה לציין שדות של מפתח וערך כדי לציין את ההזמנות.

InstanceMigrationEligibility

‫InstanceMigrationEligibility מייצג את המידע על היתכנות ההעברה מ-UmN ל-WbI.

ייצוג ב-JSON
{
  "warnings": [
    enum (Warning)
  ],
  "errors": [
    enum (Error)
  ]
}
שדות
warnings[]

enum (Warning)

פלט בלבד. הגדרות מסוימות יוגדרו כברירת מחדל במהלך ההעברה.

errors[]

enum (Error)

פלט בלבד. הגדרות מסוימות גורמות לכך ש-UmN לא עומד בדרישות להעברה אוטומטית. נדרשת העברה ידנית.

אזהרה

הודעת אזהרה לגבי העברה מציינת שהגדרות מסוימות יוגדרו כברירת מחדל במהלך ההעברה.

טיפוסים בני מנייה (enum)
WARNING_UNSPECIFIED סוג ברירת המחדל.
UNSUPPORTED_MACHINE_TYPE ה-UmN משתמש בסוג מכונה שלא נתמך ב-WbI. היא תועבר עם סוג המכונה שמוגדר כברירת מחדל e2-standard-4. המשתמשים יכולים לשנות את סוג המכונה אחרי ההעברה.
UNSUPPORTED_ACCELERATOR_TYPE ה-UmN משתמש בסוג מאיץ שלא נתמך ב-WbI. הוא יועבר ללא מאיץ. המשתמש יכול לצרף מאיץ אחרי ההעברה.
UNSUPPORTED_OS ה-UmN משתמש במערכת הפעלה שלא נתמכת ב-WbI (לדוגמה, Debian 10,‏ Ubuntu). היא תוחלף ב-Debian 11 ב-WbI.
NO_REMOVE_DATA_DISK ה-UmN הזה מוגדר עם noRemoveDataDisk, שכבר לא זמין ב-WbI.
GCS_BACKUP מספר ה-UmN הזה מוגדר עם תכונת הגיבוי של Cloud Storage, שכבר לא זמינה ב-WbI.
POST_STARTUP_SCRIPT ה-UmN הזה מוגדר עם סקריפט שמופעל אחרי ההפעלה. אפשר לציין את postStartupScriptOption להעברה.

שגיאה

הודעת שגיאה לגבי העברה מציינת שהגדרות מסוימות מונעות את ההעברה האוטומטית של מספר הטלפון. נדרשת העברה ידנית.

טיפוסים בני מנייה (enum)
ERROR_UNSPECIFIED סוג ברירת המחדל.
DATAPROC_HUB ה-UmN משתמש ב-Dataproc Hub ואי אפשר להעביר אותו.

Methods

create

יוצרת מופע חדש בפרויקט ובמיקום נתונים.

delete

מחיקה של מופע יחיד.

diagnose

יוצר קובץ אבחון ומריץ את הכלי לאבחון בעיות בהינתן מופע.

get

קבלת פרטים של מופע יחיד.

getIamPolicy

מקבלת את מדיניות בקרת הגישה למשאב.

getInstanceHealth

בודק אם מופע של מחברת תקין.

isUpgradeable

בודקת אם אפשר לשדרג את מופע ה-Notebook.

list

הצגת רשימה של מופעים בפרויקט ובמיקום נתונים.

migrate

העברה של מחברת קיימת בניהול משתמשים ל-Workbench Instances.

register

רושם מופע קיים של מחברת מדור קודם בשרת Notebooks API.

report

מאפשרת למופעי מחברת לדווח על פרטי המופע העדכניים שלהם לשרת Notebooks API.

reset

איפוס של מכונת ה-notebook.

rollback

החזרה של מחברת לגרסה הקודמת.

setAccelerator

עדכון המאיצים של האורח במכונה יחידה.

setIamPolicy

הגדרת מדיניות בקרת הגישה במשאב שצוין.

setLabels

הפונקציה מחליפה את כל התוויות של מופע.

setMachineType

מעדכן את סוג המכונה של מופע יחיד.

start

מפעיל מכונת notebook.

stop

הפסקת מכונת notebook.

testIamPermissions

הפונקציה מחזירה את ההרשאות שיש למבצע הקריאה במשאב שצוין.

updateConfig

עדכון ההגדרות של מופע Notebook.

updateMetadataItems

הוספה או עדכון של פריטי מטא-נתונים למופע.

updateShieldedInstanceConfig

מעדכנים את ההגדרות של מכונה מוגנת.

upgrade

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