Package google.cloud.notebooks.v1

אינדקס

ManagedNotebookService

שירות API v1 ל-Managed Notebooks.

CreateRuntime

rpc CreateRuntime(CreateRuntimeRequest) returns (Operation)

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

היקפי הרשאות

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

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

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

DeleteRuntime

rpc DeleteRuntime(DeleteRuntimeRequest) returns (Operation)

מחיקה של סביבת זמן ריצה אחת.

היקפי הרשאות

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

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

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

GetRuntime

rpc GetRuntime(GetRuntimeRequest) returns (Runtime)

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

היקפי הרשאות

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

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

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

ListRuntimes

rpc ListRuntimes(ListRuntimesRequest) returns (ListRuntimesResponse)

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

היקפי הרשאות

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

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

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

MigrateRuntime

rpc MigrateRuntime(MigrateRuntimeRequest) returns (Operation)

העברה של סביבת זמן ריצה קיימת למופע חדש של Workbench.

היקפי הרשאות

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

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

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

ReportRuntimeEvent

rpc ReportRuntimeEvent(ReportRuntimeEventRequest) returns (Operation)

מדווח על אירוע בזמן ריצה ומעבד אותו.

היקפי הרשאות

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

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

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

ResetRuntime

rpc ResetRuntime(ResetRuntimeRequest) returns (Operation)

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

היקפי הרשאות

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

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

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

StartRuntime

rpc StartRuntime(StartRuntimeRequest) returns (Operation)

מפעיל סביבת ריצה של מחברת מנוהלת. מבצעים פעולת 'התחלה' במופעי GPU ופעולת 'הפעלה מחדש' במופעי CPU. למידע נוסף: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

היקפי הרשאות

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

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

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

StopRuntime

rpc StopRuntime(StopRuntimeRequest) returns (Operation)

הפסקת זמן ריצה של מחברת מנוהלת. מבצעים פעולת 'עצירה' במופעי GPU ופעולת 'השהיה' במופעי CPU. למידע נוסף: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

היקפי הרשאות

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

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

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

SwitchRuntime

rpc SwitchRuntime(SwitchRuntimeRequest) returns (Operation)

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

היקפי הרשאות

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

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

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

UpdateRuntime

rpc UpdateRuntime(UpdateRuntimeRequest) returns (Operation)

עדכון ההגדרות של זמן הריצה של ה-Notebook.

היקפי הרשאות

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

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

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

NotebookService

שירות API v1 ל-Cloud AI Platform Notebooks.

CreateEnvironment

rpc CreateEnvironment(CreateEnvironmentRequest) returns (Operation)

יוצר סביבה חדשה.

היקפי הרשאות

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

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

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

CreateExecution

rpc CreateExecution(CreateExecutionRequest) returns (Operation)

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של 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.

CreateSchedule

rpc CreateSchedule(CreateScheduleRequest) returns (Operation)

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

היקפי הרשאות

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

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

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

DeleteEnvironment

rpc DeleteEnvironment(DeleteEnvironmentRequest) returns (Operation)

מחיקה של סביבה יחידה.

היקפי הרשאות

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

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

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

DeleteExecution

rpc DeleteExecution(DeleteExecutionRequest) 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.

DeleteSchedule

rpc DeleteSchedule(DeleteScheduleRequest) 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.

GetEnvironment

rpc GetEnvironment(GetEnvironmentRequest) returns (Environment)

קבלת פרטים של סביבה יחידה.

היקפי הרשאות

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

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

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

GetExecution

rpc GetExecution(GetExecutionRequest) returns (Execution)

קבלת פרטים על הרצות

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של 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.

GetInstanceHealth

rpc GetInstanceHealth(GetInstanceHealthRequest) returns (GetInstanceHealthResponse)

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

היקפי הרשאות

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

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

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

GetSchedule

rpc GetSchedule(GetScheduleRequest) returns (Schedule)

קבלת פרטים על לוח זמנים

היקפי הרשאות

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

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

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

IsInstanceUpgradeable

rpc IsInstanceUpgradeable(IsInstanceUpgradeableRequest) returns (IsInstanceUpgradeableResponse)

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

היקפי הרשאות

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

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

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

ListEnvironments

rpc ListEnvironments(ListEnvironmentsRequest) returns (ListEnvironmentsResponse)

הצגת רשימה של הסביבות בפרויקט.

היקפי הרשאות

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

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

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

ListExecutions

rpc ListExecutions(ListExecutionsRequest) returns (ListExecutionsResponse)

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של 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.

ListSchedules

rpc ListSchedules(ListSchedulesRequest) returns (ListSchedulesResponse)

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

היקפי הרשאות

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

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

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

MigrateInstance

rpc MigrateInstance(MigrateInstanceRequest) returns (Operation)

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

היקפי הרשאות

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

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

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

RegisterInstance

rpc RegisterInstance(RegisterInstanceRequest) returns (Operation)

רושם מופע קיים של מחברת מדור קודם בשרת Notebooks API. מכונות מדור קודם הן מכונות שנוצרו באמצעות קריאות מדור קודם ל-Compute Engine. אי אפשר לנהל אותם באמצעות Notebooks API בלי לבצע שינויים. הקריאה הזו מאפשרת לנהל את המקרים האלה באמצעות Notebooks API.

היקפי הרשאות

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

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

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

ReportInstanceInfo

rpc ReportInstanceInfo(ReportInstanceInfoRequest) returns (Operation)

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של 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.

RollbackInstance

rpc RollbackInstance(RollbackInstanceRequest) returns (Operation)

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

היקפי הרשאות

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

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

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

SetInstanceAccelerator

rpc SetInstanceAccelerator(SetInstanceAcceleratorRequest) returns (Operation)

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

היקפי הרשאות

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

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

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

SetInstanceLabels

rpc SetInstanceLabels(SetInstanceLabelsRequest) returns (Operation)

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

היקפי הרשאות

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

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

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

SetInstanceMachineType

rpc SetInstanceMachineType(SetInstanceMachineTypeRequest) 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.

UpdateInstanceConfig

rpc UpdateInstanceConfig(UpdateInstanceConfigRequest) returns (Operation)

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

היקפי הרשאות

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

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

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

UpdateInstanceMetadataItems

rpc UpdateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest) returns (UpdateInstanceMetadataItemsResponse)

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

היקפי הרשאות

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

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

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

UpdateShieldedInstanceConfig

rpc UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest) returns (Operation)

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של 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.

ContainerImage

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

שדות
repository

string

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

tag

string

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

CreateEnvironmentRequest

בקשה ליצירת סביבת מחברת.

שדות
parent

string

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

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

  • notebooks.environments.create
environment_id

string

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

environment

Environment

חובה. הסביבה שרוצים ליצור.

CreateExecutionRequest

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

שדות
parent

string

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

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

  • notebooks.executions.create
execution_id

string

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

execution

Execution

חובה. ההפעלה שצריך ליצור.

CreateInstanceRequest

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

שדות
parent

string

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

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

  • notebooks.instances.create
instance_id

string

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

instance

Instance

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

CreateRuntimeRequest

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

שדות
parent

string

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

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

  • notebooks.runtimes.create
runtime_id

string

חובה. מזהה ייחודי שהוגדר על ידי המשתמש של זמן הריצה הזה.

runtime

Runtime

חובה. סביבת זמן הריצה שרוצים ליצור.

request_id

string

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

CreateScheduleRequest

בקשה ליצירת קובצי notebook מתוזמנים

שדות
parent

string

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

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

  • notebooks.schedules.create
schedule_id

string

חובה. מזהה ייחודי שהוגדר על ידי המשתמש ללוח הזמנים הזה.

schedule

Schedule

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

DeleteEnvironmentRequest

בקשה למחיקת סביבת נוטבוק.

שדות
name

string

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

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

  • notebooks.environments.delete

DeleteExecutionRequest

בקשה למחיקת ביצוע מתוזמן של מחברת

שדות
name

string

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

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

  • notebooks.executions.delete

DeleteInstanceRequest

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

שדות
name

string

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

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

  • notebooks.instances.delete

DeleteRuntimeRequest

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

שדות
name

string

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

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

  • notebooks.runtimes.delete
request_id

string

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

DeleteScheduleRequest

בקשה למחיקת לוח זמנים

שדות
name

string

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

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

  • notebooks.schedules.delete

DiagnoseInstanceRequest

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

שדות
name

string

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

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/

repair_flag_enabled

bool

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

packet_capture_flag_enabled

bool

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

copy_home_files_flag_enabled

bool

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

EncryptionConfig

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

שדות
kms_key

string

מזהה משאב Cloud KMS של מפתח ההצפנה בניהול הלקוח שמשמש להגנה על משאב, כמו דיסקים. הפורמט הוא: projects/{PROJECT_ID}/locations/{REGION}/keyRings/{KEY_RING_NAME}/cryptoKeys/{KEY_NAME}

סביבה

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

שדות
name

string

פלט בלבד. שם הסביבה. פורמט: projects/{project_id}/locations/{location}/environments/{environment_id}

display_name

string

השם המוצג של הסביבה הזו בממשק המשתמש.

description

string

תיאור קצר של הסביבה.

post_startup_script

string

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

create_time

Timestamp

פלט בלבד. השעה שבה הסביבה הזו נוצרה.

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

VmImage

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

container_image

ContainerImage

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

אירוע

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

שדות
report_time

Timestamp

הזמן שבו האירוע דווח.

type

EventType

סוג האירוע.

details

map<string, string>

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

EventType

ההגדרה של סוגי האירועים.

טיפוסים בני מנייה (enum)
EVENT_TYPE_UNSPECIFIED לא צוין אירוע.
IDLE המופע או זמן הריצה לא פעילים
HEARTBEAT המופע או זמן הריצה זמינים. האירוע הזה מציין שהמחשוב הבסיסי של המופע או של זמן הריצה פועל.
HEALTH מצב התקינות של המופע או זמן הריצה זמין. האירוע הזה מציין מידע על תקינות המופע או זמן הריצה.
MAINTENANCE המופע או זמן הריצה זמינים. האירוע הזה מאפשר למופע או לסביבת זמן ריצה לשלוח מידע על תחזוקת המארח למישור הבקרה. https://cloud.google.com/compute/docs/gpus/gpu-host-maintenance

הרצה

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

שדות
execution_template

ExecutionTemplate

מטא-נתונים של ההפעלה, כולל שם, מפרט חומרה, אזור, תוויות וכו'.

name

string

פלט בלבד. שם המשאב של ההפעלה. פורמט: projects/{project_id}/locations/{location}/executions/{execution_id}

display_name

string

פלט בלבד. השם שמשמש למטרות ממשק משתמש. השם יכול להכיל רק תווים אלפאנומריים וקווים תחתונים '_'.

description

string

תיאור קצר של ההפעלה הזו.

create_time

Timestamp

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

update_time

Timestamp

פלט בלבד. השעה שבה העדכון האחרון של ההרצה בוצע.

state

State

פלט בלבד. המצב של העבודה הבסיסית ב-AI Platform.

output_notebook_file

string

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

job_uri

string

פלט בלבד. ה-URI של העבודה החיצונית שמשמשת להרצת הנוטבוק.

מדינה

תיאור של מצב עבודת ה-AIP הבסיסית, כפי שמוגדר ב-Enum.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED סטטוס העבודה לא צוין.
QUEUED המשימה נוצרה זה עתה והעיבוד שלה עדיין לא התחיל.
PREPARING השירות מתכונן להפעלת העבודה.
RUNNING העבודה מתבצעת.
SUCCEEDED העבודה הושלמה בהצלחה.
FAILED העבודה נכשלה. הפרמטר error_message צריך לכלול את פרטי הכשל.
CANCELLING המשימה בתהליך ביטול. error_message צריך לתאר את הסיבה לביטול.
CANCELLED המשימה בוטלה. error_message צריך לתאר את הסיבה לביטול.
EXPIRED התוקף של המשימה פג (רלוונטי למשימות ב-Vertex AI)
INITIALIZING ההפעלה נוצרת.

ExecutionTemplate

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

שדות
scale_tier
(deprecated)

ScaleTier

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

master_type

string

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

אפשר להשתמש ישירות בשדה הזה בסוגי מכונות מסוימים של Compute Engine. הסוגים הבאים נתמכים:

  • n1-standard-4
  • n1-standard-8
  • n1-standard-16
  • n1-standard-32
  • n1-standard-64
  • n1-standard-96
  • n1-highmem-2
  • n1-highmem-4
  • n1-highmem-8
  • n1-highmem-16
  • n1-highmem-32
  • n1-highmem-64
  • n1-highmem-96
  • n1-highcpu-16
  • n1-highcpu-32
  • n1-highcpu-64
  • n1-highcpu-96

לחלופין, אפשר להשתמש בסוגי המכונות הבאים מדור קודם:

  • standard
  • large_model
  • complex_model_s
  • complex_model_m
  • complex_model_l
  • standard_gpu
  • complex_model_m_gpu
  • complex_model_l_gpu
  • standard_p100
  • complex_model_m_p100
  • standard_v100
  • large_model_v100
  • complex_model_m_v100
  • complex_model_l_v100

לבסוף, אם רוצים להשתמש ב-TPU לאימון, מציינים cloud_tpu בשדה הזה. מידע נוסף על אפשרויות ההגדרה המיוחדות לאימון באמצעות TPU

accelerator_config

SchedulerAcceleratorConfig

הגדרות (מספר וסוג המאיץ) של החומרה שבה מופעלת מחברת.

labels

map<string, string>

תוויות להפעלה. אם ההפעלה מתוזמנת, השדה שייכלל הוא nbs-scheduled. אחרת, מדובר בהפעלה מיידית, והשדה שייכלל יהיה 'nbs-immediate'. אפשר להשתמש בשדות כדי ליצור אינדקס יעיל בין סוגים שונים של ביצועים.

input_notebook_file

string

הנתיב לקובץ הנוטבוק שרוצים להריץ. חייב להיות בקטגוריה של Google Cloud Storage. פורמט: gs://{bucket_name}/{folder}/{notebook_file_name} דוגמה: gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb

container_image_uri

string

‫URI של קובץ אימג' של קונטיינר ל-DLVM. לדוגמה: gcr.io/deeplearning-platform-release/base-cu100. דוגמאות נוספות זמינות בכתובת: https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container

output_notebook_folder

string

הנתיב לתיקיית הנוטבוק שאליה ייכתב. הנתיב צריך להיות בקטגוריה של Google Cloud Storage. פורמט: gs://{bucket_name}/{folder} דוגמה: gs://notebook_user/scheduled_notebooks

params_yaml_file

string

פרמטרים שיוחלף הערך שלהם ב-notebook במהלך ההרצה. בקישור https://papermill.readthedocs.io/en/latest/usage-parameterize.html מוסבר איך לציין פרמטרים ב-notebook של הקלט ולהעביר אותם כאן בקובץ YAML. לדוגמה: gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml

parameters

string

פרמטרים שנעשה בהם שימוש במחברת 'input_notebook_file'.

service_account

string

כתובת האימייל של חשבון השירות שבו רוצים להשתמש כשמריצים את ההפעלה. צריכה להיות לכם ההרשאה iam.serviceAccounts.actAs בחשבון השירות שצוין.

job_type

JobType

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

kernel_spec

string

השם של מפרט הליבה שבו רוצים להשתמש. צריך לציין את השם הזה אם שם מפרט הליבה ביעד ההפעלה לא זהה לשם בקובץ המחברת של הקלט.

tensorboard

string

השם של משאב [Tensorboard] ב-Vertex AI שאליו יועלו יומני Tensorboard של ההפעלה הזו. פורמט: projects/{project}/locations/{location}/tensorboards/{tensorboard}

שדה איחוד job_parameters. פרמטרים לסוג ביצוע. הערה: כרגע אין פרמטרים נוספים לעבודות ב-VertexAI. הערך job_parameters יכול להיות רק אחד מהבאים:
dataproc_parameters

DataprocParameters

פרמטרים שמשמשים בהפעלות של JobType ב-Dataproc.

vertex_ai_parameters

VertexAIParameters

פרמטרים שמשמשים בהרצות של Vertex AI JobType.

DataprocParameters

פרמטרים שמשמשים בהפעלות של JobType ב-Dataproc.

שדות
cluster

string

כתובת ה-URI של האשכול שמשמש להרצת ביצוע Dataproc. פורמט: projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}

JobType

הקצה העורפי שבו נעשה שימוש בהרצה הזו.

טיפוסים בני מנייה (enum)
JOB_TYPE_UNSPECIFIED לא צוין סוג.
VERTEX_AI משימה בהתאמה אישית ב-aiplatform.googleapis.com. ערך ברירת המחדל של הפעלה.
DATAPROC הפעלת ביצוע באשכול באמצעות Dataproc כמשימה. https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs

ScaleTier

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

טיפוסים בני מנייה (enum)
SCALE_TIER_UNSPECIFIED רמת Scale לא צוינה.
BASIC worker instance יחיד. השכבה הזו מתאימה ללימוד השימוש ב-Cloud ML ולניסויים עם מודלים חדשים באמצעות מערכי נתונים קטנים.
STANDARD_1 הרבה עובדים וכמה שרתי פרמטרים.
PREMIUM_1 מספר גדול של עובדים עם הרבה שרתי פרמטרים.
BASIC_GPU מופע יחיד של Worker עם GPU מסוג K80.
BASIC_TPU ‫worker instance יחיד עם Cloud TPU.
CUSTOM

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

  • חובה להגדיר את ExecutionTemplate.masterType כדי לציין את סוג המכונה שבה רוצים להשתמש לצומת הראשי. זו ההגדרה היחידה שנדרשת.

SchedulerAcceleratorConfig

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

שדות
type

SchedulerAcceleratorType

סוג המאיץ.

core_count

int64

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

SchedulerAcceleratorType

סוגים של שיפור המהירות באמצעות חומרה למשימות אימון ב-AI Platform.

טיפוסים בני מנייה (enum)
SCHEDULER_ACCELERATOR_TYPE_UNSPECIFIED סוג המאיץ לא צוין. ברירת המחדל היא ללא GPU.
NVIDIA_TESLA_K80 Nvidia Tesla K80 GPU.
NVIDIA_TESLA_P100 ‫Nvidia Tesla P100 GPU.
NVIDIA_TESLA_V100 ‫Nvidia Tesla V100 GPU.
NVIDIA_TESLA_P4 Nvidia Tesla P4 GPU.
NVIDIA_TESLA_T4 ‫Nvidia Tesla T4 GPU.
NVIDIA_TESLA_A100 Nvidia Tesla A100 GPU.
TPU_V2 TPU v2.
TPU_V3 TPU v3.

VertexAIParameters

פרמטרים שמשמשים בהרצות של Vertex AI JobType.

שדות
network

string

השם המלא של הרשת ב-Compute Engine שאליה העבודה צריכה להיות מחוברת. לדוגמה, projects/12345/global/networks/myVPC. הפורמט Format הוא בצורה projects/{project}/global/networks/{network}. כאשר {project} הוא מספר הפרויקט, כמו 12345, ו-{network} הוא שם הרשת.

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

env

map<string, string>

משתני סביבה. אפשר לציין עד 100 משתני סביבה ייחודיים. לדוגמה: GCP_BUCKET=gs://my-bucket/samples/

GetEnvironmentRequest

בקשה לקבלת סביבת מחברת.

שדות
name

string

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

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

  • notebooks.environments.get

GetExecutionRequest

בקשה לקבלת ביצוע מתוזמן של מחברת

שדות
name

string

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

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

  • notebooks.executions.get

GetInstanceHealthRequest

בקשה לבדיקה אם מכונת ה-notebook תקינה.

שדות
name

string

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

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

  • notebooks.instances.getHealth

GetInstanceHealthResponse

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

שדות
health_state

HealthState

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

health_info

map<string, string>

פלט בלבד. מידע נוסף על תקינות המופע. Example: healthInfo": { "docker_proxy_agent_status": "1", "docker_status": "1", "jupyterlab_api_status": "-1", "jupyterlab_status": "-1", "updated": "2020-10-18 09:40:03.573409" }

HealthState

אם מופע תקין או לא.

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

GetInstanceRequest

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

שדות
name

string

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

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

  • notebooks.instances.get

GetRuntimeRequest

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

שדות
name

string

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

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

  • notebooks.runtimes.get

GetScheduleRequest

בקשה לקבלת notebook מתוזמן.

שדות
name

string

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

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

  • notebooks.schedules.get

Instance

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

שדות
name

string

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

post_startup_script

string

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

proxy_uri

string

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

instance_owners[]

string

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

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

service_account

string

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

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

service_account_scopes[]

string

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

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

machine_type

string

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

accelerator_config

AcceleratorConfig

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

state

State

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

install_gpu_driver

bool

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

custom_gpu_driver_path

string

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

boot_disk_type

DiskType

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

boot_disk_size_gb

int64

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

data_disk_type

DiskType

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

data_disk_size_gb

int64

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

no_remove_data_disk

bool

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

disk_encryption

DiskEncryption

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

kms_key

string

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

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

disks[]

Disk

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

shielded_instance_config

ShieldedInstanceConfig

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

no_public_ip

bool

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

no_proxy_access

bool

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

network

string

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

subnet

string

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

labels

map<string, string>

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

metadata

map<string, string>

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

tags[]

string

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

upgrade_history[]

UpgradeHistoryEntry

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

nic_type

NicType

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

reservation_affinity

ReservationAffinity

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

creator

string

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

can_ip_forward

bool

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

create_time

Timestamp

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

update_time

Timestamp

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

instance_migration_eligibility

InstanceMigrationEligibility

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

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

VmImage

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

container_image

ContainerImage

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

migrated

bool

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

AcceleratorConfig

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

שדות
type

AcceleratorType

סוג המאיץ.

core_count

int64

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

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.

דיסק

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

שדות
auto_delete

bool

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

boot

bool

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

device_name

string

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

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

disk_size_gb

int64

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

guest_os_features[]

GuestOsFeature

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

index

int64

אינדקס מבוסס-אפס של הדיסק הזה, כאשר 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

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

שדות
type

string

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

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

DiskEncryption

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

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

DiskType

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

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

NicType

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

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

ShieldedInstanceConfig

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

שדות
enable_secure_boot

bool

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

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

enable_vtpm

bool

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

enable_integrity_monitoring

bool

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

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

מדינה

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

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

UpgradeHistoryEntry

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

שדות
snapshot

string

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

vm_image

string

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

container_image

string

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

framework

string

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

version

string

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

state

State

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

create_time

Timestamp

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

target_image
(deprecated)

string

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

action

Action

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

target_version

string

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

פעולה

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

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

מדינה

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

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

InstanceConfig

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

שדות
notebook_upgrade_schedule

string

ביטוי Cron באזור הזמן UTC, שמשמש לתזמון שדרוג אוטומטי של המופע. צריך להשתמש בפורמט cron.

enable_health_monitoring

bool

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

InstanceMigrationEligibility

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

שדות
warnings[]

Warning

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

errors[]

Error

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

שגיאה

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

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

אזהרה

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

טיפוסים בני מנייה (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 הזה מוגדר עם no_remove_data_disk, שכבר לא זמין ב-WbI.
GCS_BACKUP מספר ה-UmN הזה מוגדר עם תכונת הגיבוי של Cloud Storage, שכבר לא זמינה ב-WbI.
POST_STARTUP_SCRIPT ה-UmN הזה מוגדר עם סקריפט שמופעל אחרי ההפעלה. אפשר לציין את post_startup_script_option להעברה.

IsInstanceUpgradeableRequest

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

שדות
notebook_instance

string

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

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

  • notebooks.instances.checkUpgradability
type

UpgradeType

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

IsInstanceUpgradeableResponse

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

שדות
upgradeable

bool

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

upgrade_version

string

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

upgrade_info

string

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

upgrade_image

string

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

ListEnvironmentsRequest

בקשה להוספת סביבות לרישום.

שדות
parent

string

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

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

  • notebooks.environments.list
page_size

int32

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

page_token

string

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

ListEnvironmentsResponse

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

שדות
environments[]

Environment

רשימה של סביבות שהוחזרו.

next_page_token

string

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

unreachable[]

string

מיקומים שלא ניתן להגיע אליהם.

ListExecutionsRequest

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

שדות
parent

string

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

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

  • notebooks.executions.list
page_size

int32

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

page_token

string

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

filter

string

המסנן מופעל על ההרצות שמתקבלות. בשלב הזה, המערכת תומכת רק בסינון של הפעלות לפי schedule_id ספציפי. פורמט: schedule_id=<Schedule_ID>

order_by

string

מיון לפי שדה.

ListExecutionsResponse

תשובה לרשימת הרצות מתוזמנות של מחברות

שדות
executions[]

Execution

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

next_page_token

string

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

unreachable[]

string

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

['projects/{project_id}/location/{location}/executions/imagenet_test1',
 'projects/{project_id}/location/{location}/executions/classifier_train1']

ListInstancesRequest

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

שדות
parent

string

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

כדי לתת הרשאה, צריך את הרשאת 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

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

ListRuntimesRequest

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

שדות
parent

string

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

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

  • notebooks.runtimes.list
page_size

int32

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

page_token

string

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

order_by

string

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

filter

string

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

ListRuntimesResponse

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

שדות
runtimes[]

Runtime

רשימה של זמני ריצה שהוחזרו.

next_page_token

string

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

unreachable[]

string

מיקומים שלא ניתן להגיע אליהם. לדוגמה, ['us-west1', 'us-central1']. התשובה ListRuntimesResponse תכיל רק את ה-runtimes או את ה-unreachables,

ListSchedulesRequest

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

שדות
parent

string

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

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

  • notebooks.schedules.list
page_size

int32

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

page_token

string

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

filter

string

המסנן מופעל על הפעולות המתוזמנות שמתקבלות.

order_by

string

השדה שלפיו ימוינו התוצאות.

ListSchedulesResponse

תשובה לבקשה לתזמון משימה של נוטבוק.

שדות
schedules[]

Schedule

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

next_page_token

string

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

unreachable[]

string

לוחות זמנים שלא ניתן להגיע אליהם. לדוגמה:

['projects/{project_id}/location/{location}/schedules/monthly_digest',
 'projects/{project_id}/location/{location}/schedules/weekly_sentiment']

LocalDisk

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

שדות
auto_delete

bool

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

boot

bool

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

device_name

string

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

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

guest_os_features[]

RuntimeGuestOsFeature

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

index

int32

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

initialize_params

LocalDiskInitializeParams

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

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

interface

string

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

  • NVME
  • SCSI
kind

string

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

licenses[]

string

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

mode

string

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

  • READ_ONLY
  • READ_WRITE
source

string

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

type

string

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

  • PERSISTENT
  • SCRATCH

RuntimeGuestOsFeature

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

שדות
type

string

המזהה של תכונה נתמכת. רשימת האפשרויות הזמינות

הערכים האפשריים:

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

LocalDiskInitializeParams

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

שדות
description

string

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

disk_name

string

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

disk_size_gb

int64

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

disk_type

DiskType

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

labels

map<string, string>

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

DiskType

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

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

MigrateInstanceRequest

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

שדות
name

string

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

לצורך הרשאה נדרשת אחת או יותר מההרשאות הבאות ב-IAM במשאב שצוין name:

  • notebooks.instances.get
  • notebooks.instances.create
post_startup_script_option

PostStartupScriptOption

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

PostStartupScriptOption

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

טיפוסים בני מנייה (enum)
POST_STARTUP_SCRIPT_OPTION_UNSPECIFIED לא צוינה אפשרות לסקריפט לטעינה בזמן ההפעלה. ברירת המחדל היא POST_STARTUP_SCRIPT_OPTION_SKIP.
POST_STARTUP_SCRIPT_OPTION_SKIP לא להעביר את הסקריפט לטעינה בזמן ההפעלה למופע החדש של סביבת העבודה.
POST_STARTUP_SCRIPT_OPTION_RERUN מורידים מחדש את אותו סקריפט לטעינה בזמן ההפעלה ומריצים אותו כ-User-Managed Notebook.

MigrateInstanceResponse

בסוג הזה אין שדות.

סוג התגובה של הודעה ריקה עבור MigrateInstance.

MigrateRuntimeRequest

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

שדות
name

string

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

לצורך הרשאה נדרשת אחת או יותר מההרשאות הבאות ב-IAM במשאב שצוין name:

  • notebooks.runtimes.get
  • notebooks.instances.create
network

string

זה שינוי אופציונלי. השם של ה-VPC שבו נמצא המופע החדש. הפעולה הזו נדרשת אם סביבת זמן הריצה משתמשת ברשת שמנוהלת על ידי Google. אם סביבת זמן הריצה משתמשת ברשת בבעלות הלקוח, היא תשתמש מחדש באותו VPC, והשדה הזה צריך להיות ריק. פורמט: projects/{project_id}/global/networks/{network_id}

subnet

string

זה שינוי אופציונלי. השם של רשת המשנה שבה נמצא המופע החדש. הפעולה הזו נדרשת אם סביבת זמן הריצה משתמשת ברשת שמנוהלת על ידי Google. אם סביבת זמן הריצה משתמשת ברשת בבעלות הלקוח, היא תשתמש מחדש באותה רשת משנה, והשדה הזה צריך להיות ריק. פורמט: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}

service_account

string

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

request_id

string

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

post_startup_script_option

PostStartupScriptOption

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

PostStartupScriptOption

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

טיפוסים בני מנייה (enum)
POST_STARTUP_SCRIPT_OPTION_UNSPECIFIED לא צוינה אפשרות לסקריפט לטעינה בזמן ההפעלה. ברירת המחדל היא POST_STARTUP_SCRIPT_OPTION_SKIP.
POST_STARTUP_SCRIPT_OPTION_SKIP לא להעביר את הסקריפט לטעינה בזמן ההפעלה למופע החדש של סביבת העבודה.
POST_STARTUP_SCRIPT_OPTION_RERUN מורידים מחדש את אותו סקריפט לטעינה בזמן ההפעלה ומריצים אותו כמו מחברת Google מנוהלת.

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 של הפעולה הזו.

RegisterInstanceRequest

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

שדות
parent

string

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

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

  • notebooks.instances.create
instance_id

string

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

ReportInstanceInfoRequest

בקשה שמכונות Notebook ידווחו על מידע ל-Notebooks API.

שדות
name

string

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

vm_id

string

חובה. טוקן החומרה של המכונה הווירטואלית לאימות המכונה הווירטואלית. https://cloud.google.com/compute/docs/instances/verifying-instance-identity

metadata

map<string, string>

המטא-נתונים שמדווחים ל-Notebooks API. הנתונים ימוזגו עם מאגר המטא-נתונים של המופע

ReportRuntimeEventRequest

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

שדות
name

string

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

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

  • iam.permissions.none
vm_id

string

חובה. טוקן החומרה של המכונה הווירטואלית לאימות המכונה הווירטואלית. https://cloud.google.com/compute/docs/instances/verifying-instance-identity

event

Event

חובה. האירוע שיש לדווח עליו.

ReservationAffinity

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

שדות
consume_reservation_type

Type

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

key

string

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

values[]

string

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

סוג

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

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

ResetInstanceRequest

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

שדות
name

string

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

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

  • notebooks.instances.reset

ResetRuntimeRequest

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

שדות
name

string

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

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

  • notebooks.runtimes.reset
request_id

string

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

RollbackInstanceRequest

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

שדות
name

string

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

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

  • iam.permissions.none
target_snapshot

string

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

זמן ריצה

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

שדות
name

string

פלט בלבד. שם המשאב של זמן הריצה. פורמט: projects/{project}/locations/{location}/runtimes/{runtimeId}

state

State

פלט בלבד. המצב של סביבת זמן הריצה.

health_state

HealthState

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

access_config

RuntimeAccessConfig

הגדרות התצורה לגישה לזמן הריצה.

software_config

RuntimeSoftwareConfig

הגדרות התצורה של התוכנה בתוך זמן הריצה.

metrics

RuntimeMetrics

פלט בלבד. כולל מדדים של דמון זמן הריצה, כמו סטטוס השירות ונתונים סטטיסטיים של JupyterLab.

create_time

Timestamp

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

update_time

Timestamp

פלט בלבד. מועד העדכון של זמן הריצה.

labels

map<string, string>

זה שינוי אופציונלי. התוויות שמשויכות ל-Managed Notebook או לסביבת זמן הריצה. מפתחות של תוויות צריכים להכיל 1 עד 63 תווים, ולעמוד בדרישות של RFC 1035. הערכים של התוויות יכולים להיות ריקים, אבל אם הם קיימים, הם צריכים להכיל בין תו אחד ל-63 תווים, ולעמוד בדרישות של RFC 1035. אפשר לשייך עד 32 תוויות לאשכול.

runtime_migration_eligibility

RuntimeMigrationEligibility

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

שדה איחוד runtime_type. סוג זמן הריצה. בשלב הזה יש תמיכה רק במכונה וירטואלית ב-Compute Engine. הערך runtime_type יכול להיות רק אחד מהבאים:
virtual_machine

VirtualMachine

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

migrated

bool

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

HealthState

מצב המשנה של זמן הריצה.

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

מדינה

ההגדרה של המצבים של זמן הריצה הזה.

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

RuntimeAcceleratorConfig

הגדרה של סוגי מאיצי החומרה שאפשר להשתמש בהם. מידע על סוגי מאיצים ב-Compute Engine דוגמאות:

  • nvidia-tesla-k80
  • nvidia-tesla-p100
  • nvidia-tesla-v100
  • nvidia-tesla-p4
  • nvidia-tesla-t4
  • nvidia-tesla-a100
שדות
type

AcceleratorType

מודל מאיץ.

core_count

int64

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

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 – 40GB.
NVIDIA_L4 סוג המאיץ הוא Nvidia L4.
TPU_V2 (בקרוב) סוג המאיץ הוא TPU V2.
TPU_V3 (בקרוב) סוג המאיץ הוא TPU V3.
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.

RuntimeAccessConfig

הגדרת הכניסה לסביבת זמן הריצה

שדות
access_type

RuntimeAccessType

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

runtime_owner

string

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

proxy_uri

string

פלט בלבד. נקודת הקצה של ה-proxy שמשמשת לגישה לסביבת זמן הריצה.

RuntimeAccessType

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

טיפוסים בני מנייה (enum)
RUNTIME_ACCESS_TYPE_UNSPECIFIED גישה לא מוגדרת.
SINGLE_USER כניסה של משתמש יחיד.
SERVICE_ACCOUNT מצב חשבון שירות. במצב Service Account, יוצר זמן הריצה יציין חשבון שירות שקיים בפרויקט הצרכן. שימוש בשדה 'חשבון שירות בזמן ריצה'. משתמשים שניגשים ל-Runtime צריכים הרשאה מסוג ActAs (משתמש בחשבון שירות).

RuntimeMetrics

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

שדות
system_metrics

map<string, string>

פלט בלבד. מדדי המערכת.

RuntimeMigrationEligibility

‫RuntimeMigrationEligibility מייצג את המידע על היתכנות של העברה מ-GmN ל-WbI.

שדות
warnings[]

Warning

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

errors[]

Error

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

שגיאה

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

טיפוסים בני מנייה (enum)
ERROR_UNSPECIFIED סוג ברירת המחדל.
CUSTOM_CONTAINER ה-GmN מוגדר עם מאגרי תגים בהתאמה אישית, ואי אפשר להעביר אותו.

אזהרה

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

טיפוסים בני מנייה (enum)
WARNING_UNSPECIFIED סוג ברירת המחדל.
UNSUPPORTED_ACCELERATOR_TYPE ה-GmN משתמש בסוג מאיץ שלא נתמך ב-WbI. הוא יועבר ללא מאיץ. המשתמשים יכולים לצרף מאיץ אחרי ההעברה.
UNSUPPORTED_OS ה-GMN משתמש במערכת הפעלה שלא נתמכת ב-WbI (למשל Debian 10). היא תוחלף ב-Debian 11 ב-WbI.
RESERVED_IP_RANGE ה-GmN הזה מוגדר עם טווח IP שמור, שכבר לא רלוונטי ב-WbI.
GOOGLE_MANAGED_NETWORK רשת ה-GMN הזו מוגדרת עם רשת שמנוהלת על ידי Google. צריך לציין את האפשרויות network ו-subnet להעברה.
POST_STARTUP_SCRIPT ה-GmN הזה מוגדר עם סקריפט לטעינה בזמן ההפעלה. אפשר לציין את post_startup_script_option להעברה.
SINGLE_USER ה-GmN הזה מוגדר במצב משתמש יחיד. אפשר לציין את האפשרות service_account להעברה.

RuntimeShieldedInstanceConfig

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

שדות
enable_secure_boot

bool

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

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

enable_vtpm

bool

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

enable_integrity_monitoring

bool

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

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

RuntimeSoftwareConfig

הגדרה של בחירת תוכנה בתוך סביבת זמן הריצה. המאפיינים שצריך להגדיר בזמן הריצה. מציינים את מפתחות המאפיינים בפורמט key:value, לדוגמה:

  • idle_shutdown: true
  • idle_shutdown_timeout: 180
  • enable_health_monitoring: true
שדות
notebook_upgrade_schedule

string

ביטוי Cron באזור הזמן UTC, שמשמש לתזמון שדרוג אוטומטי של המופע. צריך להשתמש בפורמט cron.

idle_shutdown_timeout

int32

הזמן בדקות להמתנה לפני השבתת זמן הריצה. ברירת מחדל: 180 דקות

install_gpu_driver

bool

התקנה אוטומטית של Nvidia Driver. ברירת מחדל: True

custom_gpu_driver_path

string

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

post_startup_script

string

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

kernels[]

ContainerImage

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

post_startup_script_behavior

PostStartupScriptBehavior

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

enable_health_monitoring

bool

בודק ששירותי הליבה הפנימיים פועלים. ברירת מחדל: True

idle_shutdown

bool

סביבת זמן הריצה תושבת אוטומטית אחרי idle_shutdown_time. ברירת מחדל: True

upgradeable

bool

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

disable_terminal

bool

ערך בוליאני שמציין אם הטרמינל של JupyterLab יהיה זמין או לא. ברירת מחדל: False

version

string

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

mixer_disabled

bool

ערך בוליאני שמציין אם צריך להשבית את לקוח המיקסר. ברירת מחדל: False

PostStartupScriptBehavior

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

טיפוסים בני מנייה (enum)
POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED התנהגות לא מוגדרת של סקריפט לטעינה בזמן ההפעלה אחרי הפעלה. הפעלה חד-פעמית בזמן היצירה.
RUN_EVERY_START מריץ את הסקריפט לטעינה בזמן ההפעלה שסופק במהלך היצירה אחרי ההפעלה בכל הפעלה.
DOWNLOAD_AND_RUN_EVERY_START מוריד ומריץ את הסקריפט לטעינה בזמן ההפעלה שסופק בכל הפעלה.

תזמון

ההגדרה של לוח זמנים.

שדות
name

string

פלט בלבד. השם של לוח הזמנים הזה. פורמט: projects/{project_id}/locations/{location}/schedules/{schedule_id}

display_name

string

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

description

string

תיאור קצר של הסביבה.

state

State

cron_schedule

string

לוח זמנים בפורמט cron-tab שקובע מתי המשימה תופעל. פורמט: דקה, שעה, יום בחודש, חודש, יום בשבוע, למשל 0 0 * * WED = כל יום רביעי. דוגמאות נוספות: https://crontab.guru/examples.html

time_zone

string

אזור הזמן שעליו מבוסס cron_schedule. הערך בשדה הזה חייב להיות שם של אזור זמן מתוך מסד הנתונים tz. מסד נתונים של אזורי זמן (TZ): https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

שימו לב שחלק מאזורי הזמן כוללים הוראה לגבי שעון קיץ. הכללים לשעון קיץ נקבעים לפי אזור הזמן שנבחר. כדי להשתמש ב-UTC, צריך להזין את המחרוזת 'utc'. אם לא מציינים אזור זמן, ברירת המחדל היא UTC (שנקרא גם GMT).

create_time

Timestamp

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

update_time

Timestamp

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

execution_template

ExecutionTemplate

תבנית לביצוע Notebook שמתאימה לתזמון הזה.

recent_executions[]

Execution

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

מדינה

המצב של המשימה.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED מצב לא מוגדר.
ENABLED העבודה מתבצעת כרגיל.
PAUSED המשתמש השהה את העבודה. הוא לא יפעל. משתמש יכול להשהות את העבודה באופן מכוון באמצעות Cloud Scheduler.
DISABLED המערכת השביתה את העבודה בגלל שגיאה. המשתמש לא יכול להגדיר ישירות שמשימה תושבת.
UPDATE_FAILED מצב העבודה שנובע מפעולה שנכשלה CloudScheduler.UpdateJob. כדי לשחזר משימה מהמצב הזה, צריך לנסות שוב את CloudScheduler.UpdateJob עד שתתקבל תגובה על הצלחה.
INITIALIZING המערכת יוצרת את משאב לוח הזמנים.
DELETING משאב לוח הזמנים נמחק.

SetInstanceAcceleratorRequest

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

שדות
name

string

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

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

  • notebooks.instances.setAccelerator
type

AcceleratorType

חובה. סוג המאיץ.

core_count

int64

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

SetInstanceLabelsRequest

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

שדות
name

string

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

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

  • notebooks.instances.setLabels
labels

map<string, string>

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

SetInstanceMachineTypeRequest

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

שדות
name

string

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

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

  • notebooks.instances.setMachineType
machine_type

string

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

StartInstanceRequest

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

שדות
name

string

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

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

  • notebooks.instances.start

StartRuntimeRequest

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

שדות
name

string

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

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

  • notebooks.runtimes.start
request_id

string

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

StopInstanceRequest

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

שדות
name

string

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

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

  • notebooks.instances.stop

StopRuntimeRequest

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

שדות
name

string

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

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

  • notebooks.runtimes.stop
request_id

string

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

SwitchRuntimeRequest

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

שדות
name

string

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

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

  • notebooks.runtimes.switch
machine_type

string

סוג המכונה.

accelerator_config

RuntimeAcceleratorConfig

accelerator config.

request_id

string

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

UpdateInstanceConfigRequest

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

שדות
name

string

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

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

  • notebooks.instances.updateConfig
config

InstanceConfig

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

UpdateInstanceMetadataItemsRequest

בקשה להוספה או לשינוי של פריטי מטא-נתונים עבור מופע.

שדות
name

string

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

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

  • notebooks.instances.updateConfig
items

map<string, string>

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

UpdateInstanceMetadataItemsResponse

תגובה להוספה או לשינוי של פריטי מטא-נתונים עבור מופע.

שדות
items

map<string, string>

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

UpdateRuntimeRequest

בקשה לעדכון ההגדרה של מחברת מנוהלת.

שדות
runtime

Runtime

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

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

  • notebooks.runtimes.update
update_mask

FieldMask

חובה. מציין את הנתיב, ביחס ל-Runtime, של השדה לעדכון. לדוגמה, כדי לשנות את ליבות הגדרת התוכנה, הפרמטר update_mask יצוין כ-software_config.kernels, ובגוף הבקשה PATCH יצוין הערך החדש, באופן הבא:

{
  "software_config":{
    "kernels": [{
       'repository':
       'gcr.io/deeplearning-platform-release/pytorch-gpu', 'tag':
       'latest' }],
    }
}

בשלב הזה, אפשר לעדכן רק את השדות הבאים:

  • software_config.kernels
  • software_config.post_startup_script
  • software_config.custom_gpu_driver_path
  • software_config.idle_shutdown
  • software_config.idle_shutdown_timeout
  • software_config.disable_terminal
  • labels
request_id

string

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

UpdateShieldedInstanceConfigRequest

בקשה לעדכון ההגדרה של Shielded Instance עבור מופע של מחברת. אפשר להשתמש בשיטה הזו רק במופע שהופסק

שדות
name

string

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

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

  • notebooks.instances.updateShieldInstanceConfig
shielded_instance_config

ShieldedInstanceConfig

ההגדרות של ShieldedInstance שצריך לעדכן.

UpgradeInstanceRequest

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

שדות
name

string

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

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

  • notebooks.instances.upgrade
type

UpgradeType

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

UpgradeType

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

טיפוסים בני מנייה (enum)
UPGRADE_TYPE_UNSPECIFIED לא צוין סוג השדרוג.
UPGRADE_FRAMEWORK שדרוג מסגרת ML.
UPGRADE_OS שדרוג מערכת ההפעלה.
UPGRADE_CUDA משדרגים את CUDA.
UPGRADE_ALL משדרגים הכול (מערכת הפעלה, Framework ו-CUDA).

VirtualMachine

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

שדות
instance_name

string

פלט בלבד. השם הידידותי למשתמש של מכונת Compute Engine מנוהלת.

instance_id

string

פלט בלבד. המזהה הייחודי של מכונת Compute Engine המנוהלת.

virtual_machine_config

VirtualMachineConfig

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

VirtualMachineConfig

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

שדות
zone

string

פלט בלבד. האזור שבו נמצאת המכונה הווירטואלית. אם משתמשים בבקשה אזורית, שירות ה-notebooks יבחר מיקום באזור זמן הריצה המתאים. בבקשת GET, הפרמטר zone תמיד יהיה קיים. דוגמה: * us-central1-b

machine_type

string

חובה. סוג המכונה של Compute Engine שמשמשת לסביבות זמן ריצה. השם הקצר תקין. דוגמאות: * n1-standard-2 * e2-standard-8

container_images[]

ContainerImage

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

data_disk

LocalDisk

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

encryption_config

EncryptionConfig

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

shielded_instance_config

RuntimeShieldedInstanceConfig

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

accelerator_config

RuntimeAcceleratorConfig

זה שינוי אופציונלי. הגדרת המאיץ של Compute Engine לזמן הריצה הזה.

network

string

זה שינוי אופציונלי. הרשת של Compute Engine שתשמש לתקשורת בין המכונות. אי אפשר לציין אותו עם רשת משנה. אם לא מציינים את network או את subnet, המערכת משתמשת ברשת 'default' של הפרויקט, אם היא קיימת.

כתובת URL מלאה או URI חלקי. דוגמאות:

  • https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default
  • projects/[project_id]/global/networks/default

סביבות זמן ריצה הן משאבים מנוהלים בתשתית של Google. סביבות זמן הריצה תומכות בהגדרות הרשת הבאות:

  • רשת בניהול Google (השדות Network ו-Subnet ריקים)
  • ‫VPC בפרויקט הצרכן (נדרשת רשת ורשת משנה). צריך להגדיר גישה לשירותים פרטיים.
  • VPC משותף (נדרשת רשת ורשת משנה). צריך להגדיר גישה לשירותים פרטיים.
subnet

string

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

אפשר להזין כתובת URL מלאה או URI חלקי. דוגמאות:

  • https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0
  • projects/[project_id]/regions/us-east1/subnetworks/sub0
internal_ip_only

bool

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

tags[]

string

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

guest_attributes

map<string, string>

פלט בלבד. מאפייני האורח של Compute Engine. (ראו מאפייני אורח של פרויקט ומופע).

metadata

map<string, string>

זה שינוי אופציונלי. ערכי המטא-נתונים של Compute Engine שרוצים להוסיף למכונה הווירטואלית. (ראו מטא-נתונים של פרויקטים ושל מכונות וירטואליות).

labels

map<string, string>

זה שינוי אופציונלי. התוויות לשיוך לזמן הריצה הזה. מפתחות של תוויות צריכים להכיל 1 עד 63 תווים, ולעמוד בדרישות של RFC 1035. הערכים של התוויות יכולים להיות ריקים, אבל אם הם קיימים, הם צריכים להכיל בין תו אחד ל-63 תווים, ולעמוד בדרישות של RFC 1035. אפשר לשייך עד 32 תוויות לאשכול.

nic_type

NicType

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

reserved_ip_range

string

זה שינוי אופציונלי. השם של טווח כתובות ה-IP השמור משמש לקישור בין רשתות VPC שכנות (peering). הקצאת רשת המשנה תשתמש בטווח name אם הוא הוקצה.

דוגמה: managed-notebooks-range-c

PEERING_RANGE_NAME_3=managed-notebooks-range-c
gcloud compute addresses create $PEERING_RANGE_NAME_3 \
  --global \
  --prefix-length=24 \
  --description="Google Cloud Managed Notebooks Range 24 c" \
  --network=$NETWORK \
  --addresses=192.168.0.0 \
  --purpose=VPC_PEERING

ערך השדה יהיה: managed-notebooks-range-c

boot_image

BootImage

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

BootImage

בסוג הזה אין שדות.

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

NicType

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

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

VmImage

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

שדות
project

string

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

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

string

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

image_family

string

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