Package google.cloud.notebooks.v1

索引

ManagedNotebookService

代管筆記本的 API v1 服務。

CreateRuntime

rpc CreateRuntime(CreateRuntimeRequest) returns (Operation)

在指定專案和位置中建立新的 Runtime。

授權範圍

需要下列其中一種 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)

重設代管型 Notebook 執行階段。

授權範圍

需要下列其中一種 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)

更新筆記本執行階段設定。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱Authentication Overview。

NotebookService

Cloud AI Platform Notebooks 的 API v1 服務。

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)

檢查筆記本執行個體是否可升級。

授權範圍

需要下列其中一種 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 執行個體。

授權範圍

需要下列其中一種 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)

重設筆記本執行個體。

授權範圍

需要下列其中一種 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)

啟動筆記本執行個體。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱Authentication Overview。
StopInstance

rpc StopInstance(StopInstanceRequest) returns (Operation)

停止筆記本執行個體。

授權範圍

需要下列其中一種 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}

授權需要指定資源 parent 的下列 IAM 權限：

  • notebooks.environments.create
environment_id

string

這是必要旗標，這個環境的使用者定義專屬 ID。environment_id 長度必須介於 1 至 63 個半形字元之間，只能使用小寫英文字母、數字和破折號。第一個字元須為小寫英文字母，最後一個字元不得為破折號。
environment

Environment

這是必要旗標，要建立的環境。

CreateExecutionRequest

要求建立筆記本執行作業

欄位
parent

string

這是必要旗標，格式：parent=projects/{project_id}/locations/{location}

授權需要指定資源 parent 的下列 IAM 權限：

  • notebooks.executions.create
execution_id

string

這是必要旗標，這項執行的使用者定義專屬 ID。
execution

Execution

這是必要旗標，要建立的執行作業。

CreateInstanceRequest

要求建立筆記本執行個體。

欄位
parent

string

這是必要旗標，格式：parent=projects/{project_id}/locations/{location}

授權需要指定資源 parent 的下列 IAM 權限：

  • notebooks.instances.create
instance_id

string

這是必要旗標，這個執行個體的使用者定義專屬 ID。
instance

Instance

這是必要旗標，要建立的執行個體。

CreateRuntimeRequest

要求建立代管型 Notebook 執行階段。

欄位
parent

string

這是必要旗標，格式：parent=projects/{project_id}/locations/{location}

授權需要指定資源 parent 的下列 IAM 權限：

  • notebooks.runtimes.create
runtime_id

string

這是必要旗標，這個執行階段的使用者定義專屬 ID。
runtime

Runtime

這是必要旗標，要建立的執行階段。
request_id

string

冪等要求 UUID。

CreateScheduleRequest

要求建立排程筆記本

欄位
parent

string

這是必要旗標，格式：parent=projects/{project_id}/locations/{location}

授權需要指定資源 parent 的下列 IAM 權限：

  • notebooks.schedules.create
schedule_id

string

這是必要旗標，這項排程的使用者定義專屬 ID。
schedule

Schedule

這是必要旗標，要建立的時間表。

DeleteEnvironmentRequest

要求刪除筆記本環境。

欄位
name

string

這是必要旗標，格式：projects/{project_id}/locations/{location}/environments/{environment_id}

授權需要指定資源 name 的下列 IAM 權限：

  • notebooks.environments.delete

DeleteExecutionRequest

要求刪除排定的筆記本執行作業

欄位
name

string

這是必要旗標，格式：projects/{project_id}/locations/{location}/executions/{execution_id}

授權需要指定資源 name 的下列 IAM 權限：

  • notebooks.executions.delete

DeleteInstanceRequest

要求刪除筆記本執行個體。

欄位
name

string

這是必要旗標，格式：projects/{project_id}/locations/{location}/instances/{instance_id}

授權需要指定資源 name 的下列 IAM 權限：

  • notebooks.instances.delete

DeleteRuntimeRequest

要求刪除 Managed Notebook 執行階段。

欄位
name

string

這是必要旗標，格式：projects/{project_id}/locations/{location}/runtimes/{runtime_id}

授權需要指定資源 name 的下列 IAM 權限：

  • notebooks.runtimes.delete
request_id

string

冪等要求 UUID。

DeleteScheduleRequest

要求刪除時間表

欄位
name

string

這是必要旗標，格式：projects/{project_id}/locations/{location}/schedules/{schedule_id}

授權需要指定資源 name 的下列 IAM 權限：

  • 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 bucket 位置 (必填)。必須使用路徑前置字串 (gs://$GCS_BUCKET) 格式。

權限：使用者管理的 Notebook：- storage.buckets.writer：必須授予附加至 VM 的專案服務帳戶。Google Managed Notebooks：- storage.buckets.writer：視驗證模式而定，必須授予專案的服務帳戶或附加至 VM 的使用者憑證。

Cloud Storage bucket 記錄檔會寫入 gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
relative_path

string

選用。定義 Cloud Storage bucket 中的相對儲存路徑，診斷記錄會寫入該路徑：預設路徑為 Cloud Storage bucket 的根目錄 (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 資源 ID。格式如下：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 指令碼的路徑，會在筆記本執行個體完全啟動後自動執行。路徑必須是網址或 Cloud Storage 路徑。範例："gs://path-to-file/file-name"
create_time

Timestamp

僅供輸出。建立這個環境的時間。
聯集欄位 image_type。環境類型，可以是 VM 映像檔或容器映像檔。image_type 只能是下列其中一個設定：
vm_image

VmImage

使用 Compute Engine VM 映像檔啟動筆記本執行個體。
container_image

ContainerImage

使用容器映像檔啟動 Notebook 執行個體。

事件

代管 / 半代管筆記本執行個體的事件定義。

欄位
report_time

Timestamp

事件回報時間。
type

EventType

事件類型。
details

map<string, string>

選用。活動詳細資料。這個欄位用於傳遞事件資訊。

EventType

事件類型的定義。

列舉
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 平台工作的狀態。
output_notebook_file

string

這項執行作業產生的輸出筆記本檔案
job_uri

string

僅供輸出。用於執行筆記本的外部作業 URI。

狀態

基礎 AIP 作業狀態的列舉說明。

列舉
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

指定要用於訓練工作主要工作站的虛擬機器類型。如果 scaleTier 設為 CUSTOM，就必須指定這個欄位。

您可以在這個欄位中直接使用特定 Compute Engine 機型。mapTypeId 支援的類型如下：

  • 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 bucket 中。格式：gs://{bucket_name}/{folder}/{notebook_file_name}。範例：gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb
container_image_uri

string

DLVM 的容器映像檔 URI。範例：'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 bucket 路徑中。格式：gs://{bucket_name}/{folder}。範例：gs://notebook_user/scheduled_notebooks
params_yaml_file

string

執行期間要在筆記本中覆寫的參數。請參閱 https://papermill.readthedocs.io/en/latest/usage-parameterize.html，瞭解如何在輸入筆記本中指定參數，並在 YAML 檔案中傳遞這些參數。例如：gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml
parameters

string

在「input_notebook_file」筆記本中使用的參數。
service_account

string

執行作業時要使用的服務帳戶電子郵件地址。您必須具備指定服務帳戶的 iam.serviceAccounts.actAs 權限。
job_type

JobType

這項執行作業使用的 Job 類型。
kernel_spec

string

要使用的核心規格名稱。如果執行目標上的核心規格名稱與輸入筆記本檔案中的名稱不符，就必須指定這個名稱。
tensorboard

string

這個執行作業要將 TensorBoard 記錄上傳至的 Vertex AI [TensorBoard] 資源名稱。格式：projects/{project}/locations/{location}/tensorboards/{tensorboard}
聯集欄位 job_parameters。執行類型的參數。注意：目前 Vertex AI 工作沒有額外參數。job_parameters 只能是下列其中一個設定：
dataproc_parameters

DataprocParameters

在 Dataproc JobType 執行作業中使用的參數。
vertex_ai_parameters

VertexAIParameters

在 Vertex AI JobType 執行作業中使用的參數。

DataprocParameters

在 Dataproc JobType 執行作業中使用的參數。

欄位
cluster

string

用於執行 Dataproc 執行的叢集 URI。格式：projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}

JobType

這項執行作業使用的後端。

列舉
JOB_TYPE_UNSPECIFIED 未指定類型。
VERTEX_AI aiplatform.googleapis.com中的自訂工作。執行的預設值。
DATAPROC 在叢集上以 Dataproc 作業的形式執行。https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs

ScaleTier

這是必要旗標，指定機器類型、工作站和參數伺服器的備用資源數量。

列舉
SCALE_TIER_UNSPECIFIED 未指定規模層級。
BASIC 單一 worker 執行個體。這個層級適合學習如何使用 Cloud ML，以及使用小型資料集實驗新模型。
STANDARD_1 許多工作人員和少數參數伺服器。
PREMIUM_1 大量工作站搭配多個參數伺服器。
BASIC_GPU 單一 worker 執行個體，搭載 K80 GPU。
BASIC_TPU 具有 Cloud TPU 的單一 worker 執行個體。
CUSTOM

「自訂」層級並非固定層級，而是讓您使用自己的叢集規格。使用這個層級時，請按照下列指南設定值，以設定處理叢集：

  • 您必須設定 ExecutionTemplate.masterType，指定主節點要使用的機器類型。這是唯一需要完成的設定。

SchedulerAcceleratorConfig

硬體加速器的定義。請注意，並非所有 type 和 core_count 的組合都有效。如要瞭解有效組合，請參閱「Compute Engine 上的 GPU」。不支援 TPU。

欄位
type

SchedulerAcceleratorType

這項加速器的類型。
core_count

int64

這個加速器的核心數量。

SchedulerAcceleratorType

AI Platform Training 作業的硬體加速器類型。

列舉
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。格式為 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}

授權需要指定資源 name 的下列 IAM 權限：

  • notebooks.environments.get

GetExecutionRequest

要求取得排定執行的筆記本

欄位
name

string

這是必要旗標，格式：projects/{project_id}/locations/{location}/executions/{execution_id}

授權需要指定資源 name 的下列 IAM 權限：

  • notebooks.executions.get

GetInstanceHealthRequest

要求檢查 Notebook 執行個體是否正常運作。

欄位
name

string

這是必要旗標，格式：projects/{project_id}/locations/{location}/instances/{instance_id}

授權需要指定資源 name 的下列 IAM 權限：

  • 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

執行個體是否健康。

列舉
HEALTH_STATE_UNSPECIFIED 執行個體子狀態不明。
HEALTHY 已知執行個體處於健康狀態 (例如，重要精靈正在執行)。適用於「ACTIVE」狀態。
UNHEALTHY 已知執行個體處於不良狀態 (例如重要精靈未執行)。適用於「ACTIVE」狀態。
AGENT_NOT_INSTALLED 執行個體尚未安裝健康狀態監控代理程式。適用於「有效」狀態。
AGENT_NOT_RUNNING 執行個體健康狀態監控代理程式未執行。適用於「有效」狀態。

GetInstanceRequest

要求取得筆記本執行個體。

欄位
name

string

這是必要旗標，格式：projects/{project_id}/locations/{location}/instances/{instance_id}

授權需要指定資源 name 的下列 IAM 權限：

  • notebooks.instances.get

GetRuntimeRequest

要求取得代管型筆記本執行階段。

欄位
name

string

這是必要旗標，格式：projects/{project_id}/locations/{location}/runtimes/{runtime_id}

授權需要指定資源 name 的下列 IAM 權限：

  • notebooks.runtimes.get

GetScheduleRequest

要求取得排定時間的筆記本。

欄位
name

string

這是必要旗標，格式：projects/{project_id}/locations/{location}/schedules/{schedule_id}

授權需要指定資源 name 的下列 IAM 權限：

  • notebooks.schedules.get

執行個體

筆記本執行個體的定義。

欄位
name

string

僅供輸出。這個筆記本執行個體的名稱。格式：projects/{project_id}/locations/{location}/instances/{instance_id}
post_startup_script

string

Bash 指令碼的路徑，會在筆記本執行個體完全啟動後自動執行。路徑必須是網址或 Cloud Storage 路徑 (gs://path-to-file/file-name)。
proxy_uri

string

僅供輸出。用來存取 Jupyter 筆記本的 Proxy 端點。
instance_owners[]

string

僅限輸入。建立執行個體後的擁有者。格式：alias@example.com

目前僅支援一位擁有者。如未指定，VM 執行個體服務帳戶的所有服務帳戶使用者都能使用執行個體。
service_account

string

這個執行個體上的服務帳戶，可存取其他 Google Cloud 服務。您可以使用同一專案中的任何服務帳戶，但必須具備服務帳戶使用者授權，才能使用執行個體。

如未指定，系統會使用 Compute Engine 預設服務帳戶。
service_account_scopes[]

string

選用。要納入 Compute Engine 執行個體的服務帳戶範圍 URI。

如未指定，系統會定義下列範圍： - 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

指定儲存 GPU 驅動程式的自訂 Cloud Storage 路徑。如未指定，系統會自動從官方 GPU 驅動程式中選擇。
boot_disk_type

DiskType

僅限輸入。附加至這個執行個體的開機磁碟類型，預設為標準永久磁碟 (PD_STANDARD)。
boot_disk_size_gb

int64

僅限輸入。附加至這個執行個體的開機磁碟大小 (GB)，上限為 64000 GB (64 TB)。建議的最小值為 100 GB。如未指定，則預設值為 100。
data_disk_type

DiskType

僅限輸入。連結至這個執行個體的資料磁碟類型，預設為標準永久磁碟 (PD_STANDARD)。
data_disk_size_gb

int64

僅限輸入。附加至這個執行個體的資料磁碟大小 (以 GB 為單位)，上限為 64000 GB (64 TB)。您可以根據筆記本和資料的大小選擇資料磁碟大小。如未指定，則預設值為 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

僅供輸出。已將磁碟連接至筆記本執行個體。
shielded_instance_config

ShieldedInstanceConfig

選用。Shielded VM 設定。使用支援的 Shielded VM 功能的映像檔。
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 bucket，可以使用 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

僅供輸出。傳送原始 CreateInstance 要求的實體電子郵件地址。
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。環境類型，可以是 VM 映像檔或容器映像檔。environment 只能是下列其中一個設定：
vm_image

VmImage

使用 Compute Engine VM 映像檔啟動筆記本執行個體。
container_image

ContainerImage

使用容器映像檔啟動 Notebook 執行個體。
migrated

bool

僅供輸出。布林值，指出這個筆記本是否已遷移至 Workbench 執行個體

AcceleratorConfig

硬體加速器的定義。請注意，並非所有 type 和 core_count 的組合都有效。如要瞭解有效組合，請參閱「Compute Engine 上的 GPU」。不支援 TPU。

欄位
type

AcceleratorType

這項加速器的類型。
core_count

int64

這個加速器的核心數量。

AcceleratorType

定義可在這個執行個體上使用的硬體加速器類型。

列舉
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 虛擬工作站。
NVIDIA_TESLA_P100_VWS 加速器類型為 NVIDIA Tesla P100 虛擬工作站。
NVIDIA_TESLA_P4_VWS 加速器類型為 NVIDIA Tesla P4 虛擬工作站。
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

表示您選擇的專屬裝置名稱，會反映在執行個體中執行的 Linux 作業系統 /dev/disk/by-id/google-* 樹狀結構。您可以在執行個體中使用這個名稱來指稱要掛接、調整大小或執行其他作業的裝置。

如未指定，伺服器會選擇要套用至這個磁碟的預設裝置名稱，格式為 persistent-disk-x，其中 x 是 Google Compute Engine 指派的數字。這個欄位僅適用於永久磁碟。
disk_size_gb

int64

以 2 的次方表示磁碟大小 (GB)。
guest_os_features[]

GuestOsFeature

指出要在客體作業系統上啟用的功能清單。僅適用於可開機的映像檔。如要查看可用選項清單，請參閱「啟用客體作業系統功能」。
index

int64

這個磁碟的索引 (從零開始)，其中 0 保留給開機磁碟。如果執行個體連接多個磁碟，每個磁碟都會有專屬的索引編號。
interface

string

指出要用於連結這個磁碟的磁碟介面，可以是 SCSI 或 NVME。預設值為 SCSI。永久磁碟一律必須使用 SCSI，如果您嘗試以 SCSI 以外的格式附加永久磁碟，要求就會失敗。本機 SSD 可以使用 NVME 或 SCSI。如要瞭解透過 NVMe 的 SCSI 效能特性，請參閱本機 SSD 效能。有效值：

  • NVME
  • SCSI
kind

string

資源類型。一律計算附加磁碟的#attachedDisk。
licenses[]

string

公開顯示的授權清單。保留供 Google 使用。授權代表公開和 Marketplace 映像檔的帳單和匯總使用資料。
mode

string

要附加這個磁碟的模式，可以是 READ_WRITE 或 READ_ONLY。如未指定，預設會以 READ_WRITE 模式附加磁碟。有效值：

  • READ_ONLY
  • READ_WRITE
source

string

指出現有永久磁碟資源的有效部分或完整網址。
type

string

指出磁碟類型，可以是 SCRATCH 或 PERSISTENT。有效值：

  • PERSISTENT
  • SCRATCH

GuestOsFeature

開機磁碟的訪客 OS 功能。

欄位
type

string

支援功能的 ID。如要查看可用選項清單，請參閱「啟用客體作業系統功能」。有效值：

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

DiskEncryption

磁碟加密選項的定義。

列舉
DISK_ENCRYPTION_UNSPECIFIED 未指定磁碟加密。
GMEK 使用 Google 管理的加密金鑰加密開機磁碟。
CMEK 使用客戶自行管理的加密金鑰加密開機磁碟。

DiskType

筆記本執行個體可用的磁碟類型。

列舉
DISK_TYPE_UNSPECIFIED 未設定磁碟類型。
PD_STANDARD 標準永久磁碟類型。
PD_SSD SSD 永久磁碟類型。
PD_BALANCED 平衡型永久磁碟類型。
PD_EXTREME 極端永久磁碟類型。

NicType

vNIC 驅動程式類型。預設值應為 UNSPECIFIED_NIC_TYPE。

列舉
UNSPECIFIED_NIC_TYPE 未指定類型。
VIRTIO_NET VIRTIO
GVNIC GVNIC

ShieldedInstanceConfig

一組受防護的執行個體選項。請參閱使用支援的 Shielded VM 功能的映像檔。並非所有組合都有效。

欄位
enable_secure_boot

bool

定義執行個體是否已啟用安全啟動。

安全啟動功能會驗證所有啟動元件的數位簽章。如果簽章未通過驗證，啟動程序就會暫停，這樣即可確保系統執行的軟體均真實可信。預設為停用。
enable_vtpm

bool

定義執行個體是否已啟用 vTPM。(預設為啟用)。
enable_integrity_monitoring

bool

定義執行個體是否已啟用完整性監控。

啟用執行個體啟動完整性的監控和認證功能。驗證是根據完整性政策基準執行。這個基準最初是在建立執行個體時，從隱含信任的開機映像檔衍生而來。(預設為啟用)。

狀態

這個執行個體的狀態定義。

列舉
STATE_UNSPECIFIED 未指定狀態。
STARTING 控制邏輯正在啟動執行個體。
PROVISIONING 控制邏輯會安裝必要架構，並向筆記本 Proxy 註冊執行個體
ACTIVE 執行個體運作中。
STOPPING 控制邏輯正在停止執行個體。
STOPPED 執行個體已停止。
DELETED 執行個體已刪除。
UPGRADING 執行個體正在升級。
INITIALIZING 正在建立執行個體。
REGISTERING 正在註冊執行個體。
SUSPENDING 執行個體正在暫停。
SUSPENDED 執行個體已暫停。

UpgradeHistoryEntry

VM 映像檔升級記錄的項目。

欄位
snapshot

string

升級前，這個筆記本執行個體開機磁碟的快照。
vm_image

string

這個執行個體升級前的 VM 映像檔。
container_image

string

這個執行個體升級前的容器映像檔。
framework

string

這個筆記本執行個體的架構。
version

string

升級前筆記本執行個體的版本。
state

State

這個執行個體升級記錄項目的狀態。
create_time

Timestamp

建立這個執行個體升級記錄項目的時間。
target_image
(deprecated)

string

目標 VM 映像檔。格式：ainotebooks-vm/project/image-name/name。
action

Action

動作。復原或升級。
target_version

string

目標 VM 版本，例如 m63。

動作

這個升級記錄項目的作業定義。

列舉
ACTION_UNSPECIFIED 未指定作業。
UPGRADE 請升級。
ROLLBACK 復原。

狀態

這個升級記錄項目的狀態定義。

列舉
STATE_UNSPECIFIED 未指定狀態。
STARTED 已開始升級執行個體。
SUCCEEDED 執行個體升級成功。
FAILED 執行個體升級失敗。

InstanceConfig

可更新的筆記本執行個體設定。

欄位
notebook_upgrade_schedule

string

世界標準時間時區的 Cron 運算式，用於排定執行個體自動升級作業。請採用 cron 格式。
enable_health_monitoring

bool

驗證核心內部服務是否正在運作。

InstanceMigrationEligibility

InstanceMigrationEligibility 代表從 UmN 遷移至 WbI 的可行性資訊。

欄位
warnings[]

Warning

僅供輸出。遷移期間，系統會預設某些設定。
errors[]

Error

僅供輸出。如果 UmN 採用特定設定，就無法自動遷移。必須手動遷移。

錯誤

如果收到遷移錯誤訊息，表示某些設定會導致 UmN 不符合自動遷移資格。必須手動遷移。

列舉
ERROR_UNSPECIFIED 預設類型。
DATAPROC_HUB UmN 使用 Dataproc Hub，無法遷移。

警告

遷移警告訊息表示遷移期間會採用某些預設設定。

列舉
WARNING_UNSPECIFIED 預設類型。
UNSUPPORTED_MACHINE_TYPE UmN 使用 WbI 不支援的機型。系統會以預設機型「e2-standard-4」進行遷移。遷移完成後，使用者可以變更機型。
UNSUPPORTED_ACCELERATOR_TYPE UmN 使用 WbI 不支援的加速器類型。系統進行遷移時會排除加速器。遷移完畢後，使用者可以連接加速器。
UNSUPPORTED_OS UmN 使用 WbI 不支援的作業系統 (例如 Debian 10、Ubuntu)。WbI 會改用 Debian 11。
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}

授權需要指定資源 notebookInstance 的下列 IAM 權限：

  • notebooks.instances.checkUpgradability
type

UpgradeType

選用。選用的 UpgradeType。設定這個欄位後，系統會搜尋其他運算映像檔，以升級這個執行個體。

IsInstanceUpgradeableResponse

回應：檢查筆記本執行個體是否可升級。

欄位
upgradeable

bool

執行個體是否可升級。
upgrade_version

string

如果呼叫升級端點，這個執行個體將升級至的版本。只有在 field upgradeable 為 true 時，才會填入這個欄位。
upgrade_info

string

升級的其他資訊。
upgrade_image

string

如果呼叫升級端點，這個執行個體會升級至的新映像檔自我連結。只有在 field upgradeable 為 true 時，才會填入這個欄位。

ListEnvironmentsRequest

要求列出環境。

欄位
parent

string

這是必要旗標，格式：projects/{project_id}/locations/{location}

授權需要指定資源 parent 的下列 IAM 權限：

  • 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}

授權需要指定資源 parent 的下列 IAM 權限：

  • 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

無法連線的執行作業 ID。例如：

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

ListInstancesRequest

要求列出筆記本執行個體。

欄位
parent

string

這是必要旗標，格式：parent=projects/{project_id}/locations/{location}

授權需要指定資源 parent 的下列 IAM 權限：

  • 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}

授權需要指定資源 parent 的下列 IAM 權限：

  • 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 只會包含執行階段或無法連線的項目，

ListSchedulesRequest

要求列出排定的筆記本工作。

欄位
parent

string

這是必要旗標，格式：parent=projects/{project_id}/locations/{location}

授權需要指定資源 parent 的下列 IAM 權限：

  • 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

選用。僅供輸出。指定您選擇的專屬裝置名稱，該名稱會反映到執行個體中執行的 Linux 作業系統 /dev/disk/by-id/google-* 樹狀結構。您可以在執行個體中使用這個名稱來指稱要掛接、調整大小或執行其他作業的裝置。

如未指定，伺服器會選擇預設裝置名稱套用至這個磁碟，格式為 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 以外的格式附加永久磁碟，要求就會失敗。本機 SSD 可以使用 NVME 或 SCSI。如要瞭解透過 NVMe 的 SCSI 效能特性，請參閱本機 SSD 效能。有效值：

  • NVME
  • SCSI
kind

string

僅供輸出。資源類型。一律計算附加磁碟的#attachedDisk。
licenses[]

string

僅供輸出。任何有效的公開授權。
mode

string

要附加這個磁碟的模式，可以是 READ_WRITE 或 READ_ONLY。如未指定，預設會以 READ_WRITE 模式附加磁碟。有效值：

  • READ_ONLY
  • READ_WRITE
source

string

指定現有永久磁碟資源的有效部分或完整網址。
type

string

指定磁碟類型，可以是 SCRATCH 或 PERSISTENT。如未指定，則預設為 PERSISTENT。有效值：

  • PERSISTENT
  • SCRATCH

RuntimeGuestOsFeature

選用。要在訪客作業系統上啟用的功能清單。僅適用於可開機的映像檔。請參閱「啟用客體作業系統功能」，查看可用選項清單。開機磁碟的訪客 OS 功能。

欄位
type

string

支援功能的 ID。如要查看可用選項清單，請參閱「啟用客體作業系統功能」。

有效值：

  • 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

選用。以 2 的次方為單位指定磁碟大小 (GB)。如未指定，磁碟大小會與映像檔相同 (通常為 10 GB)。指定的大小必須大於或等於 10 GB。預設為 100 GB。
disk_type

DiskType

僅限輸入。附加至這個執行個體的開機磁碟類型，預設為標準永久磁碟 (PD_STANDARD)。
labels

map<string, string>

選用。要套用至這個磁碟的標籤。這些標籤之後可透過 disks.setLabels 方法修改。這個欄位僅適用於永久磁碟。

DiskType

可能的磁碟類型。

列舉
DISK_TYPE_UNSPECIFIED 未設定磁碟類型。
PD_STANDARD 標準永久磁碟類型。
PD_SSD SSD 永久磁碟類型。
PD_BALANCED 平衡型永久磁碟類型。
PD_EXTREME 極端永久磁碟類型。

MigrateInstanceRequest

要求將使用者管理的筆記本遷移至 Workbench 執行個體。

欄位
name

string

這是必要旗標，格式：projects/{project_id}/locations/{location}/instances/{instance_id}

授權需要指定資源 name 的下列一或多項 IAM 權限：

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

PostStartupScriptOption

選用。指定遷移期間開機指令碼的行為。

PostStartupScriptOption

指定遷移期間開機指令碼的行為。

列舉
POST_STARTUP_SCRIPT_OPTION_UNSPECIFIED 未指定開機後指令碼選項。預設值為 POST_STARTUP_SCRIPT_OPTION_SKIP。
POST_STARTUP_SCRIPT_OPTION_SKIP 不會將啟動後指令碼遷移至新的 Workbench 執行個體。
POST_STARTUP_SCRIPT_OPTION_RERUN 重新下載並重新執行與使用者管理筆記本相同的開機指令碼。

MigrateInstanceResponse

這個類型沒有任何欄位。

MigrateInstance 的空白訊息回應類型。

MigrateRuntimeRequest

要求將 Runtime 遷移至 Workbench 執行個體。

欄位
name

string

這是必要旗標，格式：projects/{project_id}/locations/{location}/runtimes/{runtime_id}

授權需要指定資源 name 的下列一或多項 IAM 權限：

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

string

選用。新執行個體所在的 VPC 名稱。如果 Runtime 使用 Google 管理的網路，就必須執行這項操作。如果執行階段使用客戶擁有的網路，則會重複使用相同的虛擬私有雲，且這個欄位必須為空白。格式：projects/{project_id}/global/networks/{network_id}
subnet

string

選用。新執行個體所在的子網路名稱。如果 Runtime 使用 Google 管理的網路，就必須執行這項操作。如果執行階段使用客戶擁有的網路，系統會重複使用相同的子網路，因此這個欄位必須留空。格式：projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
service_account

string

選用。如果執行階段使用「僅限單一使用者」模式取得權限，則新 Workbench 執行個體的 Compute Engine 執行個體中會包含這個服務帳戶。如未指定，系統會使用 Compute Engine 預設服務帳戶。如果執行階段使用服務帳戶模式取得權限，系統會重複使用同一個服務帳戶，因此這個欄位必須空白。
request_id

string

選用。冪等要求 UUID。
post_startup_script_option

PostStartupScriptOption

選用。指定遷移期間開機指令碼的行為。

PostStartupScriptOption

指定遷移期間開機指令碼的行為。

列舉
POST_STARTUP_SCRIPT_OPTION_UNSPECIFIED 未指定開機後指令碼選項。預設值為 POST_STARTUP_SCRIPT_OPTION_SKIP。
POST_STARTUP_SCRIPT_OPTION_SKIP 不會將啟動後指令碼遷移至新的 Workbench 執行個體。
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 值，且 google.rpc.Status.code 為 1 (也就是 Code.CANCELLED)。
api_version

string

用於啟動作業的 API 版本。
endpoint

string

這項作業的 API 端點名稱。

RegisterInstanceRequest

要求註冊筆記本執行個體。

欄位
parent

string

這是必要旗標，格式：parent=projects/{project_id}/locations/{location}

授權需要指定資源 parent 的下列 IAM 權限：

  • notebooks.instances.create
instance_id

string

這是必要旗標，這個執行個體的使用者定義專屬 ID。instance_id 長度必須介於 1 至 63 個半形字元之間，只能使用小寫英文字母、數字和破折號。第一個字元須為小寫英文字母，最後一個字元不得為破折號。

ReportInstanceInfoRequest

要求筆記本執行個體向 Notebooks API 回報資訊。

欄位
name

string

這是必要旗標，格式：projects/{project_id}/locations/{location}/instances/{instance_id}
vm_id

string

這是必要旗標，用於驗證 VM 的 VM 硬體權杖。https://cloud.google.com/compute/docs/instances/verifying-instance-identity
metadata

map<string, string>

向 Notebooks API 回報的中繼資料。這項資訊會合併至執行個體中繼資料存放區

ReportRuntimeEventRequest

要求回報受管理 Notebook 事件。

欄位
name

string

這是必要旗標，格式：projects/{project_id}/locations/{location}/runtimes/{runtime_id}

授權需要指定資源 name 的下列 IAM 權限：

  • iam.permissions.none
vm_id

string

這是必要旗標，用於驗證 VM 的 VM 硬體權杖。https://cloud.google.com/compute/docs/instances/verifying-instance-identity
event

Event

這是必要旗標，要回報的事件。

ReservationAffinity

使用可用區預留項目的預留項目相依性。

欄位
consume_reservation_type

Type

選用。要使用的預留項目類型
key

string

選用。對應至預訂資源的標籤鍵。
values[]

string

選用。對應預訂資源的標籤值。

類型

指出是否要從預留項目消耗容量。

列舉
TYPE_UNSPECIFIED 預設類型。
NO_RESERVATION 請勿使用任何已分配的容量。
ANY_RESERVATION 使用任何可用的預留項目。
SPECIFIC_RESERVATION 必須從特定預留項目取用。必須指定鍵值欄位，才能指定預訂。

ResetInstanceRequest

要求重設筆記本執行個體

欄位
name

string

這是必要旗標，格式：projects/{project_id}/locations/{location}/instances/{instance_id}

授權需要指定資源 name 的下列 IAM 權限：

  • notebooks.instances.reset

ResetRuntimeRequest

要求重設受管理筆記本執行階段。

欄位
name

string

這是必要旗標，格式：projects/{project_id}/locations/{location}/runtimes/{runtime_id}

授權需要指定資源 name 的下列 IAM 權限：

  • notebooks.runtimes.reset
request_id

string

冪等要求 UUID。

RollbackInstanceRequest

要求回溯筆記本執行個體

欄位
name

string

這是必要旗標，格式：projects/{project_id}/locations/{location}/instances/{instance_id}

授權需要指定資源 name 的下列 IAM 權限：

  • iam.permissions.none
target_snapshot

string

這是必要旗標，用於復原的快照。範例：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>

選用。要與這個受管理筆記本或執行階段建立關聯的標籤。標籤鍵的長度必須介於 1 至 63 個字元之間，且須符合 RFC 1035。標籤值可以空白，但如果存在，則必須包含 1 到 63 個字元，且必須符合 RFC 1035。每個叢集最多只能有 32 個標籤。
runtime_migration_eligibility

RuntimeMigrationEligibility

僅供輸出。檢查從 GmN 遷移至 WbI 的可行性。
聯集欄位 runtime_type。執行階段類型，目前僅支援 Compute Engine VM。runtime_type 只能是下列其中一個設定：
virtual_machine

VirtualMachine

使用 Compute Engine VM 映像檔啟動受管理筆記本執行個體。
migrated

bool

僅供輸出。布林值，指出這個筆記本是否已遷移至 Workbench 執行個體

HealthState

執行階段子狀態。

列舉
HEALTH_STATE_UNSPECIFIED 執行階段子狀態不明。
HEALTHY 已知執行階段處於健康狀態 (例如，重要精靈正在執行)。適用於「ACTIVE」狀態。
UNHEALTHY 已知執行階段處於不正常的狀態 (例如重要常駐程式未執行)。適用於 ACTIVE 狀態。
AGENT_NOT_INSTALLED 執行階段尚未安裝健康狀態監控代理程式。適用於「有效」狀態。
AGENT_NOT_RUNNING 執行階段健康狀態監控代理程式未執行。適用於「有效」狀態。

狀態

這個執行階段的狀態定義。

列舉
STATE_UNSPECIFIED 未指定狀態。
STARTING 運算層正在啟動執行階段。目前無法使用。
PROVISIONING 運算層正在安裝必要架構，並向 Notebook Proxy 註冊執行階段。無法使用。
ACTIVE 目前執行階段正在執行中。即可開始使用。
STOPPING 控制邏輯正在停止執行階段。無法使用。
STOPPED 執行階段已停止。無法使用。
DELETING 正在刪除執行階段。無法使用。
UPGRADING 正在升級執行階段。無法使用。
INITIALIZING 系統正在建立及設定執行階段。目前無法使用。

RuntimeAcceleratorConfig

可使用的硬體加速器類型定義。請參閱 Compute Engine AcceleratorTypes。範例：

  • nvidia-tesla-k80
  • nvidia-tesla-p100
  • nvidia-tesla-v100
  • nvidia-tesla-p4
  • nvidia-tesla-t4
  • nvidia-tesla-a100
欄位
type

AcceleratorType

加速器型號。
core_count

int64

這個加速器的核心數量。

AcceleratorType

這項加速器的類型。

列舉
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 虛擬工作站。
NVIDIA_TESLA_P100_VWS 加速器類型為 NVIDIA Tesla P100 虛擬工作站。
NVIDIA_TESLA_P4_VWS 加速器類型為 NVIDIA Tesla P4 虛擬工作站。

RuntimeAccessConfig

指定 Runtime 的登入設定

欄位
access_type

RuntimeAccessType

這個執行個體的存取模式類型。
runtime_owner

string

建立後，這個執行階段的擁有者。格式：alias@example.com目前僅支援一位擁有者。
proxy_uri

string

僅供輸出。用於存取執行階段的 Proxy 端點。

RuntimeAccessType

存取執行階段的方式可能包括：驗證模式。目前僅支援單一使用者。

列舉
RUNTIME_ACCESS_TYPE_UNSPECIFIED 未指定存取權。
SINGLE_USER 單一使用者登入。
SERVICE_ACCOUNT 服務帳戶模式。在服務帳戶模式中，執行階段建立者會指定存在於消費者專案中的服務帳戶。使用「執行階段服務帳戶」欄位。存取執行階段的使用者必須具備 ActAs (服務帳戶使用者) 權限。

RuntimeMetrics

包含執行階段精靈指標，例如 OS、核心和工作階段統計資料。

欄位
system_metrics

map<string, string>

僅供輸出。系統指標。

RuntimeMigrationEligibility

RuntimeMigrationEligibility 代表從 GmN 遷移至 WbI 的可行性資訊。

欄位
warnings[]

Warning

僅供輸出。遷移期間，系統會預設某些設定。
errors[]

Error

僅供輸出。部分設定會導致 GmN 不符合自動遷移資格。必須手動遷移。

錯誤

如果出現遷移錯誤訊息，表示某些設定會導致 Google 商家檔案不符合自動遷移資格。必須手動遷移。

列舉
ERROR_UNSPECIFIED 預設類型。
CUSTOM_CONTAINER GmN 已設定自訂容器，因此無法遷移。

警告

遷移警告訊息表示遷移期間會採用某些預設設定。

列舉
WARNING_UNSPECIFIED 預設類型。
UNSUPPORTED_ACCELERATOR_TYPE GmN 使用 WbI 不支援的加速器類型。系統進行遷移時會排除加速器。遷移完畢後，使用者可以連接加速器。
UNSUPPORTED_OS GmN 使用 WbI 不支援的作業系統 (例如 Debian 10)。WbI 會改用 Debian 11。
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

一組受防護的執行個體選項。請參閱使用支援的 Shielded VM 功能的映像檔。並非所有組合都有效。

欄位
enable_secure_boot

bool

定義執行個體是否已啟用安全啟動。

安全啟動功能會驗證所有啟動元件的數位簽章。如果簽章未通過驗證，啟動程序就會暫停，這樣即可確保系統執行的軟體均真實可信。預設為停用。
enable_vtpm

bool

定義執行個體是否已啟用 vTPM。(預設為啟用)。
enable_integrity_monitoring

bool

定義執行個體是否已啟用完整性監控。

啟用執行個體啟動完整性的監控和認證功能。驗證是根據完整性政策基準執行。這個基準最初是在建立執行個體時，從隱含信任的開機映像檔衍生而來。(預設為啟用)。

RuntimeSoftwareConfig

指定執行階段內軟體的選取和設定。要在執行階段設定的屬性。屬性鍵的格式為 key:value，例如：

  • idle_shutdown: true
  • idle_shutdown_timeout: 180
  • enable_health_monitoring: true
欄位
notebook_upgrade_schedule

string

世界標準時間時區的 Cron 運算式，用於排定執行個體自動升級作業。請採用 cron 格式。
idle_shutdown_timeout

int32

關閉執行階段前等待的時間 (以分鐘為單位)。預設值：180 分鐘
install_gpu_driver

bool

自動安裝 Nvidia 驅動程式。預設值：True
custom_gpu_driver_path

string

指定儲存 GPU 驅動程式的自訂 Cloud Storage 路徑。如未指定，系統會自動從官方 GPU 驅動程式中選擇。
post_startup_script

string

Bash 指令碼的路徑，會在筆記本執行個體完全啟動後自動執行。路徑必須是網址或 Cloud Storage 路徑 (gs://path-to-file/file-name)。
kernels[]

ContainerImage

選用。使用容器映像檔清單，做為筆記本執行個體中的 Kernel。
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

開機後指令碼的行為。

列舉
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」。如未指定時區，系統會預設為世界標準時間 (也稱為格林威治標準時間)。
create_time

Timestamp

僅供輸出。建立時間表的日期和時間。
update_time

Timestamp

僅供輸出。上次更新排程的時間。
execution_template

ExecutionTemplate

與這項排程對應的筆記本執行範本。
recent_executions[]

Execution

僅供輸出。從這個時間表觸發的最新執行作業名稱，以及對應的狀態。

狀態

工作狀態。

列舉
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}

授權需要指定資源 name 的下列 IAM 權限：

  • notebooks.instances.setAccelerator
type

AcceleratorType

這是必要旗標，這項加速器的類型。
core_count

int64

這是必要旗標，這個加速器的核心數量。請注意，並非所有 type 和 core_count 的組合都有效。如要瞭解有效組合，請參閱「Compute Engine 上的 GPU」。不支援 TPU。

SetInstanceLabelsRequest

要求設定執行個體標籤。

欄位
name

string

這是必要旗標，格式：projects/{project_id}/locations/{location}/instances/{instance_id}

授權需要指定資源 name 的下列 IAM 權限：

  • notebooks.instances.setLabels
labels

map<string, string>

要套用至這個執行個體的標籤。這些標籤之後可透過 setLabels 方法修改

SetInstanceMachineTypeRequest

要求設定執行個體機型。

欄位
name

string

這是必要旗標，格式：projects/{project_id}/locations/{location}/instances/{instance_id}

授權需要指定資源 name 的下列 IAM 權限：

  • notebooks.instances.setMachineType
machine_type

string

這是必要旗標，Compute Engine 機型。

StartInstanceRequest

要求啟動筆記本執行個體

欄位
name

string

這是必要旗標，格式：projects/{project_id}/locations/{location}/instances/{instance_id}

授權需要指定資源 name 的下列 IAM 權限：

  • notebooks.instances.start

StartRuntimeRequest

要求啟動受管理筆記本執行階段。

欄位
name

string

這是必要旗標，格式：projects/{project_id}/locations/{location}/runtimes/{runtime_id}

授權需要指定資源 name 的下列 IAM 權限：

  • notebooks.runtimes.start
request_id

string

冪等要求 UUID。

StopInstanceRequest

要求停止筆記本執行個體

欄位
name

string

這是必要旗標，格式：projects/{project_id}/locations/{location}/instances/{instance_id}

授權需要指定資源 name 的下列 IAM 權限：

  • notebooks.instances.stop

StopRuntimeRequest

要求停止代管型筆記本執行階段。

欄位
name

string

這是必要旗標，格式：projects/{project_id}/locations/{location}/runtimes/{runtime_id}

授權需要指定資源 name 的下列 IAM 權限：

  • notebooks.runtimes.stop
request_id

string

冪等要求 UUID。

SwitchRuntimeRequest

要求切換受管理筆記本執行階段。

欄位
name

string

這是必要旗標，格式：projects/{project_id}/locations/{location}/runtimes/{runtime_id}

授權需要指定資源 name 的下列 IAM 權限：

  • notebooks.runtimes.switch
machine_type

string

機型。
accelerator_config

RuntimeAcceleratorConfig

加速器設定。
request_id

string

冪等要求 UUID。

UpdateInstanceConfigRequest

要求更新執行個體設定。

欄位
name

string

這是必要旗標，格式：projects/{project_id}/locations/{location}/instances/{instance_id}

授權需要指定資源 name 的下列 IAM 權限：

  • notebooks.instances.updateConfig
config

InstanceConfig

要更新的執行個體設定。

UpdateInstanceMetadataItemsRequest

要求為執行個體新增/變更中繼資料項目。

欄位
name

string

這是必要旗標，格式：projects/{project_id}/locations/{location}/instances/{instance_id}

授權需要指定資源 name 的下列 IAM 權限：

  • notebooks.instances.updateConfig
items

map<string, string>

要為執行個體新增/更新的中繼資料項目。

UpdateInstanceMetadataItemsResponse

為執行個體新增/變更中繼資料項目的回應。

欄位
items

map<string, string>

新增/更新至中繼資料的項目地圖。

UpdateRuntimeRequest

要求更新代管型筆記本設定。

欄位
runtime

Runtime

這是必要旗標，要更新的執行階段。

授權需要指定資源 runtime 的下列 IAM 權限：

  • 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

要求更新筆記本執行個體的受防護執行個體設定。您只能在停止的執行個體上使用這個方法

欄位
name

string

這是必要旗標，格式：projects/{project_id}/locations/{location}/instances/{instance_id}

授權需要指定資源 name 的下列 IAM 權限：

  • notebooks.instances.updateShieldInstanceConfig
shielded_instance_config

ShieldedInstanceConfig

要更新的 ShieldedInstance 設定。

UpgradeInstanceRequest

要求升級筆記本執行個體

欄位
name

string

這是必要旗標，格式：projects/{project_id}/locations/{location}/instances/{instance_id}

授權需要指定資源 name 的下列 IAM 權限：

  • notebooks.instances.upgrade
type

UpgradeType

選用。選用的 UpgradeType。設定這個欄位後，系統會搜尋其他運算映像檔，以升級這個執行個體。

UpgradeType

定義可在此執行個體上使用的升級類型。

列舉
UPGRADE_TYPE_UNSPECIFIED 未指定升級類型。
UPGRADE_FRAMEWORK 升級機器學習架構。
UPGRADE_OS 升級作業系統。
UPGRADE_CUDA 升級 CUDA。
UPGRADE_ALL 升級所有項目 (OS、架構和 CUDA)。

VirtualMachine

使用虛擬機器進行運算的執行階段。

欄位
instance_name

string

僅供輸出。Managed Compute Engine 執行個體的使用者易記名稱。
instance_id

string

僅供輸出。受管理 Compute Engine 執行個體的專屬 ID。
virtual_machine_config

VirtualMachineConfig

虛擬機器設定。

VirtualMachineConfig

虛擬機器的設定。

欄位
zone

string

僅供輸出。虛擬機器所在的可用區。如果使用區域要求，筆記本服務會選擇對應執行階段區域中的位置。在 GET 要求中，一律會提供可用區。示例：* us-central1-b
machine_type

string

這是必要旗標，用於執行階段的 Compute Engine 機型。簡稱有效。範例：* n1-standard-2 * e2-standard-8
container_images[]

ContainerImage

選用。使用容器映像檔清單，做為筆記本執行個體中的 Kernel。
data_disk

LocalDisk

這是必要旗標，資料磁碟選項設定。
encryption_config

EncryptionConfig

選用。虛擬機器資料磁碟的加密設定。
shielded_instance_config

RuntimeShieldedInstanceConfig

選用。Shielded VM 執行個體設定。
accelerator_config

RuntimeAcceleratorConfig

選用。這個執行階段的 Compute Engine 加速器設定。
network

string

選用。用於機器通訊的 Compute Engine 網路。無法與子網路一併指定。如果未指定 network 或 subnet，系統會使用專案的「預設」網路 (如有)。

完整網址或部分 URI。範例：

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

執行階段是 Google 基礎架構內的受管理資源。執行階段支援下列網路設定：

  • Google 代管的網路 (網路和子網路為空白)
  • 用戶專案虛擬私有雲 (必須提供網路和子網路)。必須設定私人服務存取權。
  • Shared VPC (必須提供網路和子網路)。必須設定私人服務存取權。
subnet

string

選用。用於機器通訊的 Compute Engine 子網路。無法與網路一起指定。

完整網址或部分 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 位址，且每個 VM 都會獲派臨時外部 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。標籤值可以空白，但如果存在，則必須包含 1 到 63 個字元，且必須符合 RFC 1035。每個叢集最多只能有 32 個標籤。
nic_type

NicType

選用。這個介面使用的 vNIC 類型。這可能是 gVNIC 或 VirtioNet。
reserved_ip_range

string

選用。保留的 IP 範圍名稱會用於虛擬私有雲對等互連。如果您已指派子網路分配作業，該項作業就會使用 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。

列舉
UNSPECIFIED_NIC_TYPE 未指定類型。
VIRTIO_NET VIRTIO
GVNIC GVNIC

VmImage

自訂 Compute Engine 虛擬機器映像檔的定義，用於啟動筆記本執行個體，並直接在 VM 上安裝環境。

欄位
project

string

這是必要旗標，這個 VM 映像檔所屬的 Google Cloud 專案名稱。格式：{project_id}
聯集欄位 image。外部 Compute Engine VM 映像檔的參照。image 只能是下列其中一個設定：
image_name

string

使用 VM 映像檔名稱尋找映像檔。
image_family

string

使用這個 VM 映像檔系列尋找映像檔，系統會使用這個系列中最新的映像檔。