Package google.cloud.notebooks.v2

אינדקס

NotebookService

שירות API v2 למכונות של Workbench Notebooks.

CheckInstanceUpgradability

rpc CheckInstanceUpgradability(CheckInstanceUpgradabilityRequest) returns (CheckInstanceUpgradabilityResponse)

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

ניתן למצוא מידע נוסף כאן: Authentication Overview.
CreateInstance

rpc CreateInstance(CreateInstanceRequest) returns (Operation)

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

ניתן למצוא מידע נוסף כאן: Authentication Overview.
DeleteInstance

rpc DeleteInstance(DeleteInstanceRequest) returns (Operation)

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

ניתן למצוא מידע נוסף כאן: Authentication Overview.
DiagnoseInstance

rpc DiagnoseInstance(DiagnoseInstanceRequest) returns (Operation)

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

ניתן למצוא מידע נוסף כאן: Authentication Overview.
GetConfig

rpc GetConfig(GetConfigRequest) returns (Config)

הפונקציה מחזירה פרמטרים שונים של הגדרות.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

ניתן למצוא מידע נוסף כאן: Authentication Overview.
GetInstance

rpc GetInstance(GetInstanceRequest) returns (Instance)

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

ניתן למצוא מידע נוסף כאן: Authentication Overview.
ListInstances

rpc ListInstances(ListInstancesRequest) returns (ListInstancesResponse)

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

ניתן למצוא מידע נוסף כאן: Authentication Overview.
ResetInstance

rpc ResetInstance(ResetInstanceRequest) returns (Operation)

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

ניתן למצוא מידע נוסף כאן: Authentication Overview.
ResizeDisk

rpc ResizeDisk(ResizeDiskRequest) returns (Operation)

שינוי הגודל של דיסק של מופע Notebook לקיבולת גבוהה יותר.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

ניתן למצוא מידע נוסף כאן: Authentication Overview.
RestoreInstance

rpc RestoreInstance(RestoreInstanceRequest) returns (Operation)

‫RestoreInstance משחזרת מכונה מ-BackupSource.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

ניתן למצוא מידע נוסף כאן: Authentication Overview.
RollbackInstance

rpc RollbackInstance(RollbackInstanceRequest) returns (Operation)

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

ניתן למצוא מידע נוסף כאן: Authentication Overview.
StartInstance

rpc StartInstance(StartInstanceRequest) returns (Operation)

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

ניתן למצוא מידע נוסף כאן: Authentication Overview.
StopInstance

rpc StopInstance(StopInstanceRequest) returns (Operation)

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

ניתן למצוא מידע נוסף כאן: Authentication Overview.
UpdateInstance

rpc UpdateInstance(UpdateInstanceRequest) returns (Operation)

‫UpdateInstance מעדכן מכונה.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

ניתן למצוא מידע נוסף כאן: Authentication Overview.
UpgradeInstance

rpc UpgradeInstance(UpgradeInstanceRequest) returns (Operation)

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

ניתן למצוא מידע נוסף כאן: Authentication Overview.

AcceleratorConfig

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

שדות
type

AcceleratorType

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

int64

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

AcceleratorType

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

טיפוסים בני מנייה (enum)
ACCELERATOR_TYPE_UNSPECIFIED לא צוין סוג המאיץ.
NVIDIA_TESLA_P100

הוצא משימוש: במקומו צריך להשתמש ב-NVIDIA_TESLA_T4 (N1) או ב-NVIDIA_L4 (G2). ‫Compute Engine מוציא משימוש את ה-GPU‏ 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 – 40GB.
NVIDIA_A100_80GB סוג המאיץ הוא Nvidia Tesla A100 - 80GB.
NVIDIA_L4 סוג המאיץ הוא Nvidia Tesla L4.
NVIDIA_H100_80GB סוג המאיץ הוא Nvidia Tesla H100 – 80GB.
NVIDIA_H100_MEGA_80GB סוג המאיץ הוא Nvidia Tesla H100 - MEGA 80GB.
NVIDIA_H200_141GB סוג המאיץ הוא Nvidia Tesla H200 – 141GB.
NVIDIA_TESLA_T4_VWS סוג המאיץ הוא NVIDIA Tesla T4 Virtual Workstations.
NVIDIA_TESLA_P100_VWS

הוצא משימוש: במקומו צריך להשתמש ב-NVIDIA_TESLA_T4_VWS. ‫Compute Engine מוציא משימוש את NVIDIA Tesla P100 GPU (תחנות עבודה וירטואליות) בכל המערכת, והוא כבר לא זמין למופעים חדשים.
NVIDIA_TESLA_P4_VWS סוג המאיץ הוא NVIDIA Tesla P4 Virtual Workstations.
NVIDIA_B200 סוג המאיץ הוא NVIDIA B200.
NVIDIA_RTX6000 ‫NVIDIA RTX 6000.

AccessConfig

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

שדות
external_ip

string

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

BootDisk

ההגדרה של דיסק אתחול.

שדות
disk_size_gb

int64

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

DiskType

זה שינוי אופציונלי. מציין את סוג הדיסק.
disk_encryption

DiskEncryption

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

string

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

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

CheckInstanceUpgradabilityRequest

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

שדות
notebook_instance

string

חובה. פורמט: projects/{project_id}/locations/{location}/instances/{instance_id}

כדי לתת הרשאה, צריך את הרשאת IAM הבאה במשאב שצוין notebookInstance:

  • notebooks.instances.checkUpgradability

CheckInstanceUpgradabilityResponse

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

שדות
upgradeable

bool

אם אפשר לשדרג את המופע.
upgrade_version

string

הגרסה שאליה המופע הזה ישודרג אם מתקשרים לנקודת הקצה של השדרוג. השדה הזה יאוכלס רק אם הערך של השדה 'ניתן לשדרוג' הוא true.
upgrade_info

string

מידע נוסף על השדרוג
upgrade_image

string

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

ConfidentialInstanceConfig

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

שדות
confidential_instance_type

ConfidentialInstanceType

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

ConfidentialInstanceType

סוג המופע הסודי.

טיפוסים בני מנייה (enum)
CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED לא צוין סוג. אין להשתמש בערך הזה.
SEV ‫AMD Secure Encrypted Virtualization.

הגדרה

תשובה לקבלת הגדרות WbI במיקום

שדות
default_values

DefaultValues

פלט בלבד. ערכי ברירת המחדל של ההגדרה.
supported_values

SupportedValues

פלט בלבד. הערכים הנתמכים להגדרה.
available_images[]

ImageRelease

פלט בלבד. רשימת התמונות הזמינות ליצירת תמונה עם תיאור.
disable_workbench_legacy_creation

bool

פלט בלבד. דגל להשבתת היצירה של מחברות Workbench מדור קודם (מחברות שמנוהלות על ידי משתמשים ומחברות שמנוהלות על ידי Google).

ContainerImage

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

שדות
repository

string

חובה. הנתיב למאגר של קובץ אימג' של קונטיינר. לדוגמה: gcr.io/{project_id}/{image_name}
tag

string

זה שינוי אופציונלי. התג של קובץ האימג' של הקונטיינר. אם לא מציינים תג, ברירת המחדל היא התג האחרון.

CreateInstanceRequest

בקשה ליצירת מופע של מחברת.

שדות
parent

string

חובה. פורמט: parent=projects/{project_id}/locations/{location}

כדי לתת הרשאה, צריך את הרשאת IAM הבאה במשאב שצוין parent:

  • notebooks.instances.create
instance_id

string

חובה. מזהה ייחודי שהוגדר על ידי המשתמש למופע הזה.
instance

Instance

חובה. המכונה שרוצים ליצור.
request_id

string

זה שינוי אופציונלי. מזהה ייחודי אוניברסלי (UUID) של בקשה אידמפוטנטית.

DataDisk

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

שדות
disk_size_gb

int64

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

DiskType

זה שינוי אופציונלי. מציין את סוג הדיסק.
disk_encryption

DiskEncryption

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

string

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

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

string

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

DefaultValues

המאפיין DefaultValues מייצג את ערכי ברירת המחדל של ההגדרות.

שדות
machine_type

string

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

DeleteInstanceRequest

בקשה למחיקת מופע של מחברת.

שדות
name

string

חובה. פורמט: projects/{project_id}/locations/{location}/instances/{instance_id}

כדי לתת הרשאה, צריך את הרשאת IAM הבאה במשאב שצוין name:

  • notebooks.instances.delete
request_id

string

זה שינוי אופציונלי. מזהה ייחודי אוניברסלי (UUID) של בקשה אידמפוטנטית.

DiagnoseInstanceRequest

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

שדות
name

string

חובה. פורמט: projects/{project_id}/locations/{location}/instances/{instance_id}

כדי לתת הרשאה, צריך את הרשאת IAM הבאה במשאב שצוין name:

  • notebooks.instances.diagnose
diagnostic_config

DiagnosticConfig

חובה. הגדרת דגלים שמשמשים להפעלת כלי האבחון
timeout_minutes

int32

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

DiagnosticConfig

הגדרת דגלים שמשמשים להפעלת כלי האבחון

שדות
gcs_bucket

string

חובה. מיקום הקטגוריה של Cloud Storage של המשתמש (חובה). הערך צריך להיות בפורמט של קידומת נתיב (gs://$GCS_BUCKET).

הרשאות: מחברות מנוהלות על ידי משתמש: – storage.buckets.writer: צריך להעניק אותה לחשבון השירות של הפרויקט שמצורף למכונה הווירטואלית. ‫Google Managed Notebooks: ‏– storage.buckets.writer: צריך לתת את ההרשאה הזו לחשבון השירות של הפרויקט או לפרטי הכניסה של המשתמש שמצורפים למכונה הווירטואלית, בהתאם למצב האימות.

קובץ היומן של קטגוריית Cloud Storage ייכתב אל gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
relative_path

string

זה שינוי אופציונלי. הגדרה של נתיב האחסון היחסי בקטגוריה של Cloud Storage שבה יירשמו יומני האבחון: נתיב ברירת המחדל יהיה ספריית הבסיס של הקטגוריה של Cloud Storage ‏ (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz). דוגמה לנתיב מלא שבו יירשם קובץ היומן: gs://$GCS_BUCKET/$RELATIVE_PATH/
enable_repair_flag

bool

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

bool

זה שינוי אופציונלי. הפעלת הדגל כדי ללכוד מנות מהמופע למשך 30 שניות
enable_copy_home_files_flag

bool

זה שינוי אופציונלי. הפעלת הדגל להעתקת כל התוכן של התיקייה /home/jupyter

DiskEncryption

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

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

DiskType

סוגי דיסקים אפשריים.

טיפוסים בני מנייה (enum)
DISK_TYPE_UNSPECIFIED לא הוגדר סוג הדיסק.
PD_STANDARD סוג של דיסק מתמיד סטנדרטי.
PD_SSD סוג הדיסק המתמיד שמבוסס על SSD.
PD_BALANCED סוג דיסק אחסון מתמיד מאוזן.
PD_EXTREME סוג דיסק אחסון מתמיד מסוג Extreme.
HYPERDISK_BALANCED מייצג את סוג דיסק האחסון המתמיד המאוזן Hyperdisk Balanced. אפשר להשתמש בו כדיסק אתחול או כדיסק נתונים.
HYPERDISK_EXTREME מייצג את סוג הדיסק לאחסון מתמיד Hyperdisk Extreme. אפשר להשתמש בו רק כדיסק נתונים.
HYPERDISK_THROUGHPUT מייצג את סוג הדיסק המתמיד Hyperdisk Throughput. אפשר להשתמש בו רק כדיסק נתונים.
HYPERDISK_BALANCED_HIGH_AVAILABILITY מייצג את סוג הדיסק המתמיד Hyperdisk Balanced High Availability. אפשר להשתמש בו כדיסק אתחול או כדיסק נתונים.
HYPERDISK_ML מייצג את סוג הדיסק המתמיד Hyperdisk ML. אפשר להשתמש בו כדיסק אתחול או כדיסק נתונים.

GPUDriverConfig

הגדרה של דרייבר GPU

שדות
enable_gpu_driver

bool

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

string

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

GceSetup

ההגדרה של אופן ההגדרה של מכונת VM מחוץ למשאבים ולזהות.

שדות
machine_type

string

זה שינוי אופציונלי. סוג המכונה של המכונה הווירטואלית. https://cloud.google.com/compute/docs/machine-resource
min_cpu_platform

string

זה שינוי אופציונלי. פלטפורמת ה-CPU המינימלית לשימוש במופע הזה. רשימת הערכים התקינים זמינה בכתובת https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform#availablezones
accelerator_configs[]

AcceleratorConfig

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

ServiceAccount

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

BootDisk

זה שינוי אופציונלי. דיסק האתחול של המכונה הווירטואלית.
data_disks[]

DataDisk

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

ShieldedInstanceConfig

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

NetworkInterface

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

bool

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

string

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

map<string, string>

זה שינוי אופציונלי. מטא-נתונים בהתאמה אישית להחלה על המופע הזה.
system_metadata

map<string, string>

פלט בלבד. מייצג מטא-נתונים שמנוהלים על ידי המערכת עבור המופע הזה: קבוצת המשנה של metadata שהמפתחות שלה הם מפתחות מערכת מוכרים של Workbench.
enable_ip_forwarding

bool

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

GPUDriverConfig

זה שינוי אופציונלי. הגדרות של דרייברים של GPU.
confidential_instance_config

ConfidentialInstanceConfig

זה שינוי אופציונלי. הגדרת מופע סודי.
instance_id

string

פלט בלבד. המזהה הייחודי של משאב המכונה ב-Compute Engine.
שדה איחוד image. סוג התמונה, שיכול להיות אחת מהאפשרויות הבאות: תמונת מכונת VM או קובץ אימג' של קונטיינר. הערך image יכול להיות רק אחד מהבאים:
vm_image

VmImage

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

ContainerImage

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

GetConfigRequest

בקשה לקבלת פרמטרים של הגדרות Workbench.

שדות
name

string

חובה. פורמט: projects/{project_id}/locations/{location}

GetInstanceRequest

בקשה לקבלת מכונת notebook.

שדות
name

string

חובה. פורמט: projects/{project_id}/locations/{location}/instances/{instance_id}

כדי לתת הרשאה, צריך את הרשאת IAM הבאה במשאב שצוין name:

  • notebooks.instances.get

HealthState

מצב התקינות של המכונה.

טיפוסים בני מנייה (enum)
HEALTH_STATE_UNSPECIFIED מצב המשנה של המופע לא ידוע.
HEALTHY ידוע שהמופע במצב תקין (לדוגמה, שדים קריטיים פועלים). רלוונטי למצב ACTIVE.
UNHEALTHY ידוע שהמופע נמצא במצב לא תקין (לדוגמה, שדים קריטיים לא פועלים). רלוונטי למצב ACTIVE.
AGENT_NOT_INSTALLED במופע לא הותקן סוכן מעקב אחרי תקינות. ההגדרה חלה על מצב פעיל.
AGENT_NOT_RUNNING הסוכן למעקב אחרי תקינות המופע לא פועל. ההגדרה חלה על מצב פעיל.

ImageRelease

‫ConfigImage מייצג גרסת תמונה שזמינה ליצירת WbI

שדות
image_name

string

פלט בלבד. השם של התמונה הוא workbench-instances-vYYYYmmdd--
release_name

string

פלט בלבד. הפרסום של התמונה של הטופס m123
image_family

string

פלט בלבד. המשפחה של התמונה. (לדוגמה: workbench-instances או workbench-2603)
description

string

פלט בלבד. תיאור התמונה.

Instance

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

שדות
name

string

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

string

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

string

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

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

string

פלט בלבד. כתובת האימייל של הישות ששלחה את הבקשה המקורית ליצירת מכונה.
state

State

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

UpgradeHistoryEntry

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

string

פלט בלבד. המזהה הייחודי של המשאב.
health_state

HealthState

פלט בלבד. Instance health_state.
health_info

map<string, string>

פלט בלבד. מידע נוסף על תקינות המופע. דוגמה:

healthInfo": {
  "docker_proxy_agent_status": "1",
  "docker_status": "1",
  "jupyterlab_api_status": "-1",
  "jupyterlab_status": "-1",
  "updated": "2020-10-18 09:40:03.573409"
}
create_time

Timestamp

פלט בלבד. הזמן שחלף מאז יצירת המכונה.
update_time

Timestamp

פלט בלבד. הזמן שבו מתבצע עדכון של המופע.
disable_proxy_access

bool

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

map<string, string>

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

string

פלט בלבד. נקודת הקצה של ה-proxy של מאגרי כוח העבודה שמשמשת לגישה לקובץ ה-notebook של Jupyter.
satisfies_pzs

bool

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

bool

פלט בלבד. שמור לשימוש עתידי לבידוד אזורים.
enable_third_party_identity

bool

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

bool

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

bool

זה שינוי אופציונלי. אם הערך הוא true, ההגנה מפני מחיקה תופעל עבור מופע Workbench הזה. אם הערך הוא False, ההגנה מפני מחיקה תושבת עבור מופע Workbench הזה.
שדה איחוד infrastructure. הגדרות של מכונת ה-Notebook. הערך infrastructure יכול להיות רק אחד מהבאים:
gce_setup

GceSetup

זה שינוי אופציונלי. הגדרת Compute Engine לנוטבוק. שימוש בשדות שמוגדרים ב-Notebook.

ListInstancesRequest

בקשה להצגת מכונות Notebook.

שדות
parent

string

חובה. ההורה של המופע. פורמטים: – projects/{project_id}/locations/{location} כדי להציג רשימה של מכונות באזור ספציפי. ‫- projects/{project_id}/locations/- כדי להציג רשימה של מכונות בכל המיקומים.

כדי לתת הרשאה, צריך את הרשאת IAM הבאה במשאב שצוין parent:

  • notebooks.instances.list
page_size

int32

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

string

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

string

זה שינוי אופציונלי. מיון התוצאות. הערכים הנתמכים הם name,‏ name desc או '' (לא ממוין).
filter

string

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

ListInstancesResponse

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

שדות
instances[]

Instance

רשימה של מופעים שהוחזרו.
next_page_token

string

טוקן דף שאפשר להשתמש בו כדי להמשיך את רשימת התוצאות מהתוצאה האחרונה בקריאה הבאה של הרשימה.
unreachable[]

string

רשימה לא ממוינת. מיקומים שלא ניתן להגיע אליהם. לדוגמה, ['projects/{project_id}/locations/us-west1-a', 'projects/{project_id}/locations/us-central1-b']. התשובה ListInstancesResponse תכיל רק מופעים או רק מופעים שלא ניתן להגיע אליהם,

NetworkInterface

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

שדות
network

string

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

string

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

NicType

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

AccessConfig

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

string

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

NicType

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

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

OperationMetadata

מייצג את המטא-נתונים של הפעולה הממושכת.

שדות
create_time

Timestamp

השעה שבה נוצרה הפעולה.
end_time

Timestamp

השעה שבה הפעולה הסתיימה.
target

string

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

string

שם הפועל שהפעולה מבצעת.
status_message

string

סטטוס הפעולה שקריא לבני אדם, אם יש כזה.
requested_cancellation

bool

הערך מציין אם המשתמש ביקש לבטל את הפעולה. בפעולות שבוטלו בהצלחה, הערך של google.longrunning.Operation.error הוא 1 עם google.rpc.Status.code, שמתאים ל-Code.CANCELLED.
api_version

string

גרסת ה-API ששימשה להפעלת הפעולה.
endpoint

string

שם נקודת קצה ל-API של הפעולה הזו.

ResetInstanceRequest

בקשה לאיפוס של מופע של מחברת

שדות
name

string

חובה. פורמט: projects/{project_id}/locations/{location}/instances/{instance_id}

כדי לתת הרשאה, צריך את הרשאת IAM הבאה במשאב שצוין name:

  • notebooks.instances.reset

ResizeDiskRequest

בקשה לשינוי הגודל של הדיסקים של מופע ה-Notebook

שדות
notebook_instance

string

חובה. פורמט: projects/{project_id}/locations/{location}/instances/{instance_id}

כדי לתת הרשאה, צריך את הרשאת IAM הבאה במשאב שצוין notebookInstance:

  • notebooks.instances.update
שדה איחוד Disk. סוג הדיסק שאפשר לשנות את הגודל שלו: דיסק אתחול או דיסק נתונים Disk יכול להיות רק אחד מהערכים הבאים:
boot_disk

BootDisk

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

DataDisk

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

RestoreInstanceRequest

בקשה לשחזור של מחברת מופעלת מ-BackupSource.

שדות
name

string

חובה. פורמט: projects/{project_id}/locations/{location}/instances/{instance_id}

כדי לתת הרשאה, צריך את הרשאת IAM הבאה במשאב שצוין name:

  • notebooks.instances.update
שדה איחוד Source. המקור שממנו יש לשחזר. הערך Source יכול להיות רק אחד מהבאים:
snapshot

Snapshot

קובץ ה-snapshot שישמש לשחזור.

RollbackInstanceRequest

בקשה להחזרת מצב של מופע Notebook

שדות
name

string

חובה. פורמט: projects/{project_id}/locations/{location}/instances/{instance_id}

כדי לתת הרשאה, צריך את הרשאת IAM הבאה במשאב שצוין name:

  • notebooks.instances.rollback
target_snapshot

string

חובה. קובץ ה-snapshot להחזרה למצב הקודם. דוגמה: projects/test-project/global/snapshots/krwlzipynril
revision_id

string

חובה. פלט בלבד. מזהה הגרסה

ServiceAccount

חשבון שירות שמשמש כזהות.

שדות
email

string

זה שינוי אופציונלי. כתובת האימייל של חשבון השירות.
scopes[]

string

פלט בלבד. רשימת ההיקפים שיהיו זמינים לחשבון השירות הזה. הערך מוגדר על ידי CLH ל-https://www.googleapis.com/auth/cloud-platform

ShieldedInstanceConfig

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

שדות
enable_secure_boot

bool

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

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

bool

זה שינוי אופציונלי. ההגדרה קובעת אם ה-vTPM מופעל במכונת ה-VM.
enable_integrity_monitoring

bool

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

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

תמונת מצב

‫Snapshot מייצג את ה-Snapshot של דיסק הנתונים שמשמש לשחזור מופע Workbench. הפניה אל: compute/v1/projects/{project_id}/global/snapshots/{snapshot_id}

שדות
snapshot_id

string

חובה. המזהה של תמונת המצב.
project_id

string

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

StartInstanceRequest

בקשה להפעלת מופע של מחברת

שדות
name

string

חובה. פורמט: projects/{project_id}/locations/{location}/instances/{instance_id}

כדי לתת הרשאה, צריך את הרשאת IAM הבאה במשאב שצוין name:

  • notebooks.instances.start

מדינה

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

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

StopInstanceRequest

בקשה להפסקת מופע של מחברת

שדות
name

string

חובה. פורמט: projects/{project_id}/locations/{location}/instances/{instance_id}

כדי לתת הרשאה, צריך את הרשאת IAM הבאה במשאב שצוין name:

  • notebooks.instances.stop

SupportedValues

המאפיין SupportedValues מייצג את הערכים שההגדרה תומכת בהם.

שדות
machine_types[]

string

פלט בלבד. סוגי המכונות שנתמכים על ידי WbI.
accelerator_types[]

string

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

UpdateInstanceRequest

בקשה לעדכון של מכונת Notebook.

שדות
instance

Instance

חובה. ייצוג של מופע.

כדי לתת הרשאה, צריך את הרשאת IAM הבאה במשאב שצוין instance:

  • iam.permissions.none
update_mask

FieldMask

חובה. מסכה שמשמשת לעדכון מופע. שדות שאפשר לעדכן:

  • labels
  • gce_setup.min_cpu_platform
  • gce_setup.metadata
  • gce_setup.machine_type
  • gce_setup.accelerator_configs
  • gce_setup.accelerator_configs.type
  • gce_setup.accelerator_configs.core_count
  • gce_setup.gpu_driver_config
  • gce_setup.gpu_driver_config.enable_gpu_driver
  • gce_setup.gpu_driver_config.custom_gpu_driver_path
  • gce_setup.shielded_instance_config
  • gce_setup.shielded_instance_config.enable_secure_boot
  • gce_setup.shielded_instance_config.enable_vtpm
  • gce_setup.shielded_instance_config.enable_integrity_monitoring
  • gce_setup.reservation_affinity
  • gce_setup.reservation_affinity.consume_reservation_type
  • gce_setup.reservation_affinity.key
  • gce_setup.reservation_affinity.values
  • gce_setup.tags
  • gce_setup.container_image
  • gce_setup.container_image.repository
  • gce_setup.container_image.tag
  • gce_setup.disable_public_ip
  • disable_proxy_access

הערה: gce_setup.disable_public_ip ו-disable_proxy_access הם חד-כיווניים בעדכון – אפשר להשתמש בהם רק כדי להשבית את התכונה (הגדרת השדה ל-true). בקשות שמגדירות את אחד מהשדות בחזרה ל-false (הפעלה מחדש של כתובת ה-IP החיצונית או הגישה לפרוקסי) נדחות עם INVALID_ARGUMENT.
request_id

string

זה שינוי אופציונלי. מזהה ייחודי אוניברסלי (UUID) של בקשה אידמפוטנטית.

UpgradeHistoryEntry

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

שדות
snapshot

string

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

string

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

string

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

string

זה שינוי אופציונלי. המסגרת של מכונת ה-notebook.
version

string

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

State

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

Timestamp

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

Action

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

string

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

פעולה

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

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

מדינה

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

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

UpgradeInstanceRequest

בקשה לשדרוג של מכונת Notebook

שדות
name

string

חובה. פורמט: projects/{project_id}/locations/{location}/instances/{instance_id}

כדי לתת הרשאה, צריך את הרשאת IAM הבאה במשאב שצוין name:

  • notebooks.instances.upgrade
image_family

string

זה שינוי אופציונלי. שם המשאב של משפחת התמונות של Compute Engine שאליה רוצים לשדרג. פורמט: projects/{project_id}/global/images/family/{image_family} אם מציינים, המופע ישודרג לתמונה העדכנית ביותר במשפחת התמונות שצוינה, כך שניתן לבצע שדרוגים בין משפחות תמונות. אם לא מציינים גרסה, המופע ישודרג לתמונה העדכנית ביותר במשפחת התמונות הנוכחית שלו.

VmImage

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

שדות
project

string

חובה. השם של הפרויקט בענן של Google שאליו שייך קובץ האימג' של המכונה הווירטואלית. פורמט: {project_id}
image_description

string

פלט בלבד. תיאור קריא לאנשים של התמונה שפועלת במופע (לדוגמה, Debian 11, Python 3.10), שנוצר בזמן הקריאה מתוך הגדרת הגרסה של התמונה (מקור האמת). מגדירים את האפשרות 'מותאם אישית' לתמונות של דיסק אתחול שלא מזוהות.
שדה איחוד image. ההפניה לקובץ אימג' חיצוני של מכונה וירטואלית ב-Compute Engine. הערך image יכול להיות רק אחד מהבאים:
name

string

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

string

זה שינוי אופציונלי. משתמשים במשפחת תמונות ה-VM הזו כדי למצוא את התמונה. התמונה הכי חדשה במשפחה הזו תשמש אתכם.