Package google.cloud.notebooks.v2

索引

NotebookService

Workbench Notebooks 執行個體的 API v2 服務。

CheckInstanceUpgradability

rpc CheckInstanceUpgradability(CheckInstanceUpgradabilityRequest) returns (CheckInstanceUpgradabilityResponse)

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

授權範圍

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

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

詳情請參閱Authentication Overview。
CreateInstance

rpc CreateInstance(CreateInstanceRequest) returns (Operation)

在指定專案和位置建立新執行個體。

授權範圍

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

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

詳情請參閱Authentication Overview。
DeleteInstance

rpc DeleteInstance(DeleteInstanceRequest) returns (Operation)

刪除單一執行個體。

授權範圍

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

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

詳情請參閱Authentication Overview。
DiagnoseInstance

rpc DiagnoseInstance(DiagnoseInstanceRequest) returns (Operation)

建立診斷檔案，並針對指定例項執行診斷工具。

授權範圍

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

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

詳情請參閱Authentication Overview。
GetConfig

rpc GetConfig(GetConfigRequest) returns (Config)

傳回各種設定參數。

授權範圍

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

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

詳情請參閱Authentication Overview。
GetInstance

rpc GetInstance(GetInstanceRequest) returns (Instance)

取得單一執行個體的詳細資料。

授權範圍

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

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

詳情請參閱Authentication Overview。
ListInstances

rpc ListInstances(ListInstancesRequest) returns (ListInstancesResponse)

列出指定專案和位置中的執行個體。

授權範圍

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

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

詳情請參閱Authentication Overview。
ResetInstance

rpc ResetInstance(ResetInstanceRequest) returns (Operation)

重設筆記本執行個體。

授權範圍

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

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

詳情請參閱Authentication Overview。
ResizeDisk

rpc ResizeDisk(ResizeDiskRequest) returns (Operation)

將筆記本執行個體磁碟調整為較大容量。

授權範圍

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

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

詳情請參閱Authentication Overview。
RestoreInstance

rpc RestoreInstance(RestoreInstanceRequest) returns (Operation)

RestoreInstance 會從 BackupSource 還原 Instance。

授權範圍

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

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

詳情請參閱Authentication Overview。
RollbackInstance

rpc RollbackInstance(RollbackInstanceRequest) returns (Operation)

將筆記本執行個體復原至前一個版本。

授權範圍

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

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

詳情請參閱Authentication Overview。
StartInstance

rpc StartInstance(StartInstanceRequest) returns (Operation)

啟動筆記本執行個體。

授權範圍

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

rpc UpdateInstance(UpdateInstanceRequest) returns (Operation)

UpdateInstance 會更新 Instance。

授權範圍

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

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

詳情請參閱Authentication Overview。
UpgradeInstance

rpc UpgradeInstance(UpgradeInstanceRequest) returns (Operation)

將筆記本執行個體升級至最新版本。

授權範圍

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

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

詳情請參閱Authentication Overview。

AcceleratorConfig

VM 執行個體的加速器設定。硬體加速器的定義。請注意，系統不會檢查 type 和 core_count 的組合。不支援 TPU。如要瞭解有效組合，請參閱「Compute Engine 上的 GPU」。

欄位
type

AcceleratorType

選用。這項加速器的類型。
core_count

int64

選用。這個加速器的核心數量。

AcceleratorType

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

列舉
ACCELERATOR_TYPE_UNSPECIFIED 未指定加速器類型。
NVIDIA_TESLA_P100

已淘汰：請改用 NVIDIA_TESLA_T4 (N1) 或 NVIDIA_L4 (G2)。Compute Engine 將在整個機群中淘汰 NVIDIA Tesla P100 GPU，因此新執行個體將無法再使用這款 GPU。
NVIDIA_TESLA_V100 加速器類型為 Nvidia Tesla V100。
NVIDIA_TESLA_P4 加速器類型為 Nvidia Tesla P4。
NVIDIA_TESLA_T4 加速器類型為 Nvidia Tesla T4。
NVIDIA_TESLA_A100 加速器類型為 Nvidia Tesla A100 - 40GB。
NVIDIA_A100_80GB 加速器類型為 Nvidia Tesla A100 - 80GB。
NVIDIA_L4 加速器類型為 Nvidia Tesla L4。
NVIDIA_H100_80GB 加速器類型為 Nvidia Tesla H100 - 80GB。
NVIDIA_H100_MEGA_80GB 加速器類型為 Nvidia Tesla H100 - MEGA 80GB。
NVIDIA_H200_141GB 加速器類型為 Nvidia Tesla H200 - 141GB。
NVIDIA_TESLA_T4_VWS 加速器類型為 NVIDIA Tesla T4 虛擬工作站。
NVIDIA_TESLA_P100_VWS

已淘汰：請改用 NVIDIA_TESLA_T4_VWS。Compute Engine 將在整個機群中淘汰 NVIDIA Tesla P100 GPU (虛擬工作站)，因此新執行個體無法再使用這項 GPU。
NVIDIA_TESLA_P4_VWS 加速器類型為 NVIDIA Tesla P4 虛擬工作站。
NVIDIA_B200 加速器類型為 NVIDIA B200。
NVIDIA_RTX6000 NVIDIA RTX 6000。

AccessConfig

附加至執行個體網路介面的存取權設定。

欄位
external_ip

string

選用。與這個執行個體相關聯的外部 IP 位址。指定專案可用的未使用靜態外部 IP 位址，或將這個欄位留空，使用共用暫時 IP 位址集區中的 IP。如果您指定靜態外部 IP 位址，該位址必須與執行個體所在的可用區位於相同區域。

BootDisk

開機磁碟的定義。

欄位
disk_size_gb

int64

選用。附加至這個執行個體的開機磁碟大小 (GB)，上限為 64000 GB (64 TB)。如未指定，則預設為建議值 150 GB。
disk_type

DiskType

選用。指出磁碟類型。
disk_encryption

DiskEncryption

選用。開機磁碟和資料磁碟使用的磁碟加密方法，預設為 GMEK。
kms_key

string

選用。用於加密磁碟的 KMS 金鑰，僅適用於 disk_encryption 為 CMEK 的情況。格式：projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

進一步瞭解如何使用自己的加密金鑰。

CheckInstanceUpgradabilityRequest

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

欄位
notebook_instance

string

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

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

  • notebooks.instances.checkUpgradability

CheckInstanceUpgradabilityResponse

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

欄位
upgradeable

bool

執行個體是否可升級。
upgrade_version

string

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

string

升級的其他資訊。
upgrade_image

string

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

ConfidentialInstanceConfig

一組機密執行個體選項。

欄位
confidential_instance_type

ConfidentialInstanceType

選用。定義機密執行個體使用的技術類型。

ConfidentialInstanceType

機密執行個體的類型。

列舉
CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED 未指定類型。請勿使用這個值。
SEV AMD 安全加密虛擬化。

設定

在某個位置取得 WbI 設定的回應

欄位
default_values

DefaultValues

僅供輸出。設定的預設值。
supported_values

SupportedValues

僅供輸出。設定支援的值。
available_images[]

ImageRelease

僅供輸出。可建立 WbI 的可用圖片清單。
disable_workbench_legacy_creation

bool

僅供輸出。這個標記可停用舊版 Workbench 筆記本 (使用者自行管理的筆記本和 Google 管理的筆記本) 的建立作業。

ContainerImage

容器映像檔的定義，用於啟動筆記本執行個體，並在容器中安裝環境。

欄位
repository

string

這是必要旗標，容器映像檔存放區的路徑。例如：gcr.io/{project_id}/{image_name}
tag

string

選用。容器映像檔的標記。如未指定，則預設為最新標記。

CreateInstanceRequest

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

欄位
parent

string

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

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

  • notebooks.instances.create
instance_id

string

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

Instance

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

string

選用。冪等要求 UUID。

DataDisk

已連結至執行個體的磁碟資源。

欄位
disk_size_gb

int64

選用。連結至這個 VM 執行個體的磁碟大小 (以 GB 為單位)，上限為 64000 GB (64 TB)。如未指定，則預設值為 100。
disk_type

DiskType

選用。指出磁碟類型。
disk_encryption

DiskEncryption

選用。開機磁碟和資料磁碟使用的磁碟加密方法，預設為 GMEK。
kms_key

string

選用。用於加密磁碟的 KMS 金鑰，僅適用於 disk_encryption 為 CMEK 的情況。格式：projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

進一步瞭解如何使用自己的加密金鑰。
resource_policies[]

string

選用。要套用至資料磁碟的資源政策。

DefaultValues

DefaultValues 代表預設設定值。

欄位
machine_type

string

僅供輸出。如果使用者未提供，後端使用的預設機型。

DeleteInstanceRequest

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

欄位
name

string

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

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

  • notebooks.instances.delete
request_id

string

選用。冪等要求 UUID。

DiagnoseInstanceRequest

要求建立筆記本執行個體診斷檔案。

欄位
name

string

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

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

  • notebooks.instances.diagnose
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/
enable_repair_flag

bool

選用。為執行個體啟用維修服務旗標
enable_packet_capture_flag

bool

選用。啟用標記，從執行個體擷取封包 30 秒
enable_copy_home_files_flag

bool

選用。啟用旗標，複製所有 /home/jupyter 資料夾內容

DiskEncryption

磁碟加密選項的定義。

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

DiskType

可能的磁碟類型。

列舉
DISK_TYPE_UNSPECIFIED 未設定磁碟類型。
PD_STANDARD 標準永久磁碟類型。
PD_SSD SSD 永久磁碟類型。
PD_BALANCED 平衡型永久磁碟類型。
PD_EXTREME 極端永久磁碟類型。
HYPERDISK_BALANCED 代表 Hyperdisk Balanced 平衡型永久磁碟類型。可做為開機磁碟或資料磁碟。
HYPERDISK_EXTREME 代表 Hyperdisk Extreme 永久磁碟類型。只能做為資料磁碟使用。
HYPERDISK_THROUGHPUT 代表 Hyperdisk Throughput 永久磁碟類型。只能做為資料磁碟使用。
HYPERDISK_BALANCED_HIGH_AVAILABILITY 代表 Hyperdisk Balanced High Availability 持久性磁碟類型。可做為開機磁碟或資料磁碟。
HYPERDISK_ML 代表 Hyperdisk ML 永久磁碟類型。可做為開機磁碟或資料磁碟。

GPUDriverConfig

GPU 驅動程式設定

欄位
enable_gpu_driver

bool

選用。使用者是否授權 Google Cloud 在這個 VM 執行個體上安裝 GPU 驅動程式。如果這個欄位空白或設為 false，系統就不會安裝 GPU 驅動程式。僅適用於搭載 GPU 的執行個體。
custom_gpu_driver_path

string

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

GceSetup

定義如何設定「資源」和「身分識別」以外的 VM 執行個體。

欄位
machine_type

string

選用。VM 執行個體的機型。https://cloud.google.com/compute/docs/machine-resource
min_cpu_platform

string

選用。這個執行個體使用的最低 CPU 平台。如需有效值清單，請參閱 https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform#availablezones。
accelerator_configs[]

AcceleratorConfig

選用。這個執行個體使用的硬體加速器。如果使用加速器，請確認設定的 vCPU 和記憶體足夠支援所選的 machine_type。目前僅支援一項加速器設定。
service_accounts[]

ServiceAccount

選用。做為 VM 執行個體身分的服務帳戶。目前僅支援一個服務帳戶。
boot_disk

BootDisk

選用。VM 的開機磁碟。
data_disks[]

DataDisk

選用。連接至 VM 執行個體的資料磁碟。目前僅支援一個資料磁碟。
shielded_instance_config

ShieldedInstanceConfig

選用。Shielded VM 設定。使用支援的 Shielded VM 功能的映像檔。
network_interfaces[]

NetworkInterface

選用。VM 的網路介面。僅支援一個介面。
disable_public_ip

bool

選用。如果為 true，系統不會為這個 VM 執行個體指派外部 IP。
tags[]

string

選用。要新增至執行階段的 Compute Engine 網路標記 (請參閱「新增網路標記」)。
metadata

map<string, string>

選用。要套用至這個執行個體的自訂中繼資料。
system_metadata

map<string, string>

僅供輸出。代表這個執行個體的系統管理中繼資料：metadata 的子集，其鍵是 Workbench 系統鍵。
enable_ip_forwarding

bool

選用。啟用或停用 IP 轉送的旗標，預設為 false/off。https://cloud.google.com/vpc/docs/using-routes#canipforward
gpu_driver_config

GPUDriverConfig

選用。GPU 驅動程式的設定。
confidential_instance_config

ConfidentialInstanceConfig

選用。機密執行個體設定。
instance_id

string

僅供輸出。Compute Engine 執行個體資源的專屬 ID。
聯集欄位 image。映像檔類型，可以是 VM 映像檔或容器映像檔。image 只能是下列其中一個設定：
vm_image

VmImage

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

ContainerImage

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

GetConfigRequest

要求取得 Workbench 設定參數。

欄位
name

string

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

GetInstanceRequest

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

欄位
name

string

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

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

  • notebooks.instances.get

HealthState

執行個體的健康狀態。

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

ImageRelease

ConfigImage 代表可用於建立 WbI 的映像檔版本

欄位
image_name

string

僅供輸出。映像檔名稱格式為 workbench-instances-vYYYYmmdd--
release_name

string

僅供輸出。發布表單 m123 的圖片
image_family

string

僅供輸出。圖片的映像檔系列。(例如：workbench-instances 或 workbench-2603)
description

string

僅供輸出。圖片說明。

執行個體

筆記本執行個體的定義。

欄位
name

string

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

string

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

string

選用。建立執行個體後的擁有者。格式：alias@example.com

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

string

僅供輸出。傳送原始 CreateInstance 要求的實體電子郵件地址。
state

State

僅供輸出。這個執行個體的狀態。
upgrade_history[]

UpgradeHistoryEntry

僅供輸出。這個執行個體的升級記錄。
id

string

僅供輸出。資源的專屬 ID。
health_state

HealthState

僅供輸出。執行個體健康狀態。
health_info

map<string, string>

僅供輸出。執行個體健康狀態的其他資訊。範例：

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

Timestamp

僅供輸出。執行個體建立時間。
update_time

Timestamp

僅供輸出。執行個體更新時間。
disable_proxy_access

bool

選用。如果為 true，筆記本執行個體就不會向 Proxy 註冊。
labels

map<string, string>

選用。要套用至這個執行個體的標籤。這些值稍後可透過 UpdateInstance 方法修改。
third_party_proxy_url

string

僅供輸出。用於存取 Jupyter 筆記本的工作團隊集區 Proxy 端點。
satisfies_pzs

bool

僅供輸出。保留供日後使用，以進行區域分離。
satisfies_pzi

bool

僅供輸出。保留供日後使用，以進行區域隔離。
enable_third_party_identity

bool

選用。這個標記會指定筆記本是否可透過第三方身分識別提供者存取。
enable_managed_euc

bool

選用。這個旗標可啟用執行個體的代管使用者憑證。
enable_deletion_protection

bool

選用。如果為 true，這個 Workbench 執行個體就會啟用防刪除功能。如果為 false，系統會停用這個 Workbench 執行個體的防刪除功能。
聯集欄位 infrastructure。設定筆記本執行個體。infrastructure 只能是下列其中一個設定：
gce_setup

GceSetup

選用。筆記本的 Compute Engine 設定。使用筆記本定義的欄位。

ListInstancesRequest

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

欄位
parent

string

這是必要旗標，執行個體的父項。格式：- projects/{project_id}/locations/{location} 列出特定可用區中的執行個體。- projects/{project_id}/locations/- 列出所有位置的執行個體。

授權需要指定資源 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

未排序的清單。無法連線的位置。例如 ['projects/{project_id}/locations/us-west1-a', 'projects/{project_id}/locations/us-central1-b']。ListInstancesResponse 只會包含執行個體或無法連線的執行個體，

NetworkInterface

附加至 VM 的網路介面資源定義。

欄位
network

string

選用。這個 VM 執行個體所在的 VPC 名稱。格式：projects/{project_id}/global/networks/{network_id}
subnet

string

選用。這個 VM 執行個體所在的子網路名稱。格式：projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
nic_type

NicType

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

AccessConfig

選用。這個介面的設定陣列。目前僅支援一個存取設定，即 ONE_TO_ONE_NAT。如未指定 accessConfigs，執行個體會透過暫時外部 IP 位址存取外部網路。
internal_ip

string

選用。與這個執行個體相關聯的內部 IP 位址。指定執行個體所在子網路可用的未使用靜態內部 IP 位址，或將這個欄位留空，使用子網路暫時範圍內的 IP。

NicType

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

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

OperationMetadata

代表長時間執行的作業中繼資料。

欄位
create_time

Timestamp

作業的建立時間。
end_time

Timestamp

作業完成的時間。
target

string

作業目標的伺服器定義資源路徑。
verb

string

作業執行的動詞名稱。
status_message

string

作業的人類可讀狀態 (如有)。
requested_cancellation

bool

判斷使用者是否要求取消作業。成功取消的作業會擁有 google.longrunning.Operation.error 值，且 google.rpc.Status.code 為 1 (也就是 Code.CANCELLED)。
api_version

string

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

string

這項作業的 API 端點名稱。

ResetInstanceRequest

要求重設筆記本執行個體

欄位
name

string

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

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

  • notebooks.instances.reset

ResizeDiskRequest

要求調整筆記本執行個體磁碟大小

欄位
notebook_instance

string

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

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

  • notebooks.instances.update
聯集欄位 Disk。可調整大小的磁碟類型：開機磁碟或資料磁碟 Disk 只能是下列其中一種：
boot_disk

BootDisk

這是必要旗標，要調整大小的開機磁碟。系統只會使用 disk_size_gb。
data_disk

DataDisk

這是必要旗標，要調整大小的資料磁碟。系統只會使用 disk_size_gb。

RestoreInstanceRequest

要求從 BackupSource 還原 Notebook 執行個體。

欄位
name

string

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

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

  • notebooks.instances.update
聯集欄位 Source。要從中還原的來源。Source 只能是下列其中一個設定：
snapshot

Snapshot

用於還原的快照。

RollbackInstanceRequest

要求回溯筆記本執行個體

欄位
name

string

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

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

  • notebooks.instances.rollback
target_snapshot

string

這是必要旗標，用於復原的快照。例如：「projects/test-project/global/snapshots/krwlzipynril」。
revision_id

string

這是必要旗標，僅供輸出。修訂版本 ID

ServiceAccount

做為身分的服務帳戶。

欄位
email

string

選用。服務帳戶的電子郵件地址。
scopes[]

string

僅供輸出。要提供給這個服務帳戶的範圍清單。由 CLH 設為 https://www.googleapis.com/auth/cloud-platform

ShieldedInstanceConfig

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

欄位
enable_secure_boot

bool

選用。定義 VM 執行個體是否已啟用安全啟動功能。

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

bool

選用。定義 VM 執行個體是否已啟用 vTPM。
enable_integrity_monitoring

bool

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

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

快照

快照代表用於還原 Workbench 執行個體的資料磁碟快照。參照：compute/v1/projects/{project_id}/global/snapshots/{snapshot_id}

欄位
snapshot_id

string

這是必要旗標，快照的 ID。
project_id

string

這是必要旗標，快照的專案 ID。

StartInstanceRequest

要求啟動筆記本執行個體

欄位
name

string

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

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

  • notebooks.instances.start

狀態

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

列舉
STATE_UNSPECIFIED 未指定狀態。
STARTING 控制邏輯正在啟動執行個體。
PROVISIONING 控制邏輯會安裝必要架構，並向筆記本 Proxy 註冊執行個體
ACTIVE 執行個體運作中。
STOPPING 控制邏輯正在停止執行個體。
STOPPED 執行個體已停止。
DELETED 執行個體已刪除。
UPGRADING 執行個體正在升級。
INITIALIZING 正在建立執行個體。
SUSPENDING 執行個體正在暫停。
SUSPENDED 執行個體已暫停。
ORPHANED 執行個體沒有 VM。升級作業移除了原始磁碟，但無法建立替代磁碟；資料磁碟和任何快照都完好無損。請重試升級以完成升級，或是將執行個體復原至升級前建立的快照。

StopInstanceRequest

要求停止筆記本執行個體

欄位
name

string

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

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

  • notebooks.instances.stop

SupportedValues

SupportedValues 代表設定支援的值。

欄位
machine_types[]

string

僅供輸出。WbI 支援的機型。
accelerator_types[]

string

僅供輸出。WbI 支援的加速器類型。

UpdateInstanceRequest

要求更新筆記本執行個體。

欄位
instance

Instance

這是必要旗標，執行個體的表示法。

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

  • iam.permissions.none
update_mask

FieldMask

這是必要旗標，用於更新執行個體的遮罩。可更新的欄位：

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

注意：gce_setup.disable_public_ip 和 disable_proxy_access 只能單向更新，也就是只能用來停用這項功能 (將欄位設為 true)。如果要求將任一欄位設回 false (重新啟用外部 IP 或 Proxy 存取權)，系統會以 INVALID_ARGUMENT 拒絕要求。
request_id

string

選用。冪等要求 UUID。

UpgradeHistoryEntry

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

欄位
snapshot

string

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

string

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

string

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

string

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

string

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

State

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

Timestamp

不可變動。建立這個執行個體升級記錄項目的時間。
action

Action

選用。動作。復原或升級。
target_version

string

選用。目標 VM 版本，例如 m63。

動作

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

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

狀態

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

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

UpgradeInstanceRequest

要求升級筆記本執行個體

欄位
name

string

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

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

  • notebooks.instances.upgrade
image_family

string

選用。要升級的 Compute Engine 映像檔系列資源名稱。格式：projects/{project_id}/global/images/family/{image_family}如果指定，執行個體會升級至指定映像檔系列中的最新映像檔，允許跨映像檔系列升級。如未指定，執行個體會升級至目前映像檔系列中的最新映像檔。

VmImage

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

欄位
project

string

這是必要旗標，這個 VM 映像檔所屬的 Google Cloud 專案名稱。格式：{project_id}
image_description

string

僅供輸出。執行個體上執行的映像檔說明 (例如「Debian 11，Python 3.10」)，會在讀取時從映像檔發布設定 (可靠資料來源) 衍生。如果開機磁碟映像檔無法辨識，請設為「自訂」。
聯集欄位 image。外部 Compute Engine VM 映像檔的參照。image 只能是下列其中一個設定：
name

string

選用。使用 VM 映像檔名稱尋找映像檔。
family

string

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