資源:執行階段
代管型筆記本執行個體的執行階段定義。
| JSON 表示法 |
|---|
{ "name": string, "state": enum ( |
| 欄位 | |
|---|---|
name |
僅供輸出。執行階段的資源名稱。格式: |
state |
僅供輸出。執行階段狀態。 |
healthState |
僅供輸出。執行階段健康狀態。 |
accessConfig |
存取執行階段的設定。 |
softwareConfig |
執行階段內軟體的設定。 |
metrics |
僅供輸出。包含執行階段精靈指標,例如服務狀態和 JupyterLab 統計資料。 |
createTime |
僅供輸出。執行階段建立時間。 使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例: |
updateTime |
僅供輸出。執行階段更新時間。 使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例: |
labels |
選用。要與這個受管理筆記本或執行階段建立關聯的標籤。標籤鍵的長度必須介於 1 至 63 個字元之間,且須符合 RFC 1035。標籤值可以空白,但如果存在,則必須包含 1 到 63 個字元,且必須符合 RFC 1035。一個叢集最多只能與 32 個標籤建立關聯。 包含 |
runtimeMigrationEligibility |
僅供輸出。檢查從 GmN 遷移至 WbI 的可行性。 |
| 執行階段類型,目前僅支援 Compute Engine VM。以下列出互斥欄位。回應中最多會設定一個欄位: | |
virtualMachine |
使用 Compute Engine VM 映像檔啟動受管理筆記本執行個體。 |
| 互斥欄位的結尾。 | |
migrated |
僅供輸出。布林值,指出這個筆記本是否已遷移至 Workbench 執行個體 |
VirtualMachine
使用虛擬機器進行運算的執行階段。
| JSON 表示法 |
|---|
{
"instanceName": string,
"instanceId": string,
"virtualMachineConfig": {
object ( |
| 欄位 | |
|---|---|
instanceName |
僅供輸出。Managed Compute Engine 執行個體的使用者易記名稱。 |
instanceId |
僅供輸出。受管理 Compute Engine 執行個體的專屬 ID。 |
virtualMachineConfig |
虛擬機器設定。 |
VirtualMachineConfig
虛擬機器的設定。
| JSON 表示法 |
|---|
{ "zone": string, "machineType": string, "containerImages": [ { object ( |
| 欄位 | |
|---|---|
zone |
僅供輸出。虛擬機器所在的可用區。如果使用區域要求,筆記本服務會選擇對應執行階段區域中的位置。在 GET 要求中,一律會提供可用區。示例:* |
machineType |
這是必要旗標,用於執行階段的 Compute Engine 機型。簡稱有效。範例:* |
containerImages[] |
選用。使用容器映像檔清單,做為筆記本執行個體中的 Kernel。 |
dataDisk |
這是必要旗標,資料磁碟選項設定。 |
encryptionConfig |
選用。虛擬機器資料磁碟的加密設定。 |
shieldedInstanceConfig |
選用。Shielded VM 執行個體設定。 |
acceleratorConfig |
選用。這個執行階段的 Compute Engine 加速器設定。 |
network |
選用。用於機器通訊的 Compute Engine 網路。無法與子網路一併指定。如果未指定 完整網址或部分 URI。範例:
執行階段是 Google 基礎架構內的受管理資源。執行階段支援下列網路設定:
|
subnet |
選用。用於機器通訊的 Compute Engine 子網路。無法與網路一起指定。 完整網址或部分 URI 皆有效。範例:
|
internalIpOnly |
選用。如果為 true,執行階段只會有內部 IP 位址。根據預設,執行階段不會限制使用內部 IP 位址,且每個 VM 都會獲派臨時外部 IP 位址。這項 |
tags[] |
選用。要新增至執行階段的 Compute Engine 網路標記 (請參閱「新增網路標記」)。 |
guestAttributes |
僅供輸出。Compute Engine 訪客屬性。(請參閱「專案和執行個體訪客屬性」)。 包含 |
metadata |
選用。要新增至虛擬機器的 Compute Engine 中繼資料項目。(請參閱「專案和執行個體中繼資料」)。 包含 |
labels |
選用。要與這個執行階段建立關聯的標籤。標籤鍵的長度必須介於 1 至 63 個字元之間,且須符合 RFC 1035。標籤值可以空白,但如果存在,則必須包含 1 到 63 個字元,且必須符合 RFC 1035。每個叢集最多只能有 32 個標籤。 包含 |
nicType |
選用。這個介面使用的 vNIC 類型。這可能是 gVNIC 或 VirtioNet。 |
reservedIpRange |
選用。保留的 IP 範圍名稱會用於虛擬私有雲對等互連。如果您已指派子網路分配作業,該項作業就會使用 name 範圍。 範例:managed-notebooks-range-c 欄位值為: |
bootImage |
選用。用於執行階段升級的開機映像檔中繼資料。 |
LocalDisk
本機附加磁碟資源。
| JSON 表示法 |
|---|
{ "autoDelete": boolean, "boot": boolean, "deviceName": string, "guestOsFeatures": [ { object ( |
| 欄位 | |
|---|---|
autoDelete |
選用。僅供輸出。指定是否要在刪除執行個體時自動刪除磁碟 (但從執行個體卸離磁碟時不會刪除)。 |
boot |
選用。僅供輸出。表示這是開機磁碟。虛擬機器會使用磁碟的第一個分割區做為根檔案系統。 |
deviceName |
選用。僅供輸出。指定您選擇的專屬裝置名稱,該名稱會反映到執行個體中執行的 Linux 作業系統 如未指定,伺服器會選擇預設裝置名稱套用至這個磁碟,格式為 persistent-disk-x,其中 x 是 Google Compute Engine 指派的數字。這個欄位僅適用於永久磁碟。 |
guestOsFeatures[] |
僅供輸出。指出要在客體作業系統上啟用的功能清單。僅適用於可開機的映像檔。如要查看可用選項清單,請參閱「啟用客體作業系統功能」。 |
index |
僅供輸出。這個磁碟的索引 (從零開始),其中 0 保留給開機磁碟。如果執行個體連接多個磁碟,每個磁碟都會有專屬的索引編號。 |
initializeParams |
僅限輸入。指定要與新執行個體一併建立的新磁碟參數。使用初始化參數建立開機磁碟,或連結至新執行個體的本機 SSD。 這項屬性與來源資源互斥,您只能定義其中一個,不能同時定義兩者。 |
interface |
指定要用於連結這個磁碟的磁碟介面,可以是 SCSI 或 NVME。預設值為 SCSI。永久磁碟一律必須使用 SCSI,如果您嘗試以 SCSI 以外的格式附加永久磁碟,要求就會失敗。本機 SSD 可以使用 NVME 或 SCSI。如要瞭解透過 NVMe 的 SCSI 效能特性,請參閱本機 SSD 效能。有效值:
|
kind |
僅供輸出。資源類型。一律計算附加磁碟的#attachedDisk。 |
licenses[] |
僅供輸出。任何有效的公開授權。 |
mode |
要附加這個磁碟的模式,可以是
|
source |
指定現有永久磁碟資源的有效部分或完整網址。 |
type |
指定磁碟類型,可以是
|
RuntimeGuestOsFeature
選用。要在訪客作業系統上啟用的功能清單。僅適用於可開機的映像檔。請參閱「啟用客體作業系統功能」,查看可用選項清單。開機磁碟的訪客 OS 功能。
| JSON 表示法 |
|---|
{ "type": string } |
| 欄位 | |
|---|---|
type |
支援功能的 ID。如要查看可用選項清單,請參閱「啟用客體作業系統功能」。 有效值:
|
LocalDiskInitializeParams
僅限輸入。指定要與新執行個體一併建立的新磁碟參數。使用初始化參數建立開機磁碟或本機 SSD,並附加至新的執行階段。這項屬性與來源資源互斥,您只能定義其中一個,不能同時定義兩者。
| JSON 表示法 |
|---|
{
"description": string,
"diskName": string,
"diskSizeGb": string,
"diskType": enum ( |
| 欄位 | |
|---|---|
description |
選用。建立磁碟時請提供這項屬性。 |
diskName |
選用。指定磁碟名稱。如未指定,預設會使用執行個體的名稱。如果指定可用區/區域中已有與執行個體名稱相同的磁碟,系統會自動產生新名稱。 |
diskSizeGb |
選用。以 2 的次方為單位指定磁碟大小 (GB)。如未指定,磁碟大小會與映像檔相同 (通常為 10 GB)。指定的大小必須大於或等於 10 GB。預設為 100 GB。 |
diskType |
僅限輸入。附加至這個執行個體的開機磁碟類型,預設為標準永久磁碟 ( |
labels |
選用。要套用至這個磁碟的標籤。這些標籤之後可透過 disks.setLabels 方法修改。這個欄位僅適用於永久磁碟。 包含 |
DiskType
可能的磁碟類型。
| 列舉 | |
|---|---|
DISK_TYPE_UNSPECIFIED |
未設定磁碟類型。 |
PD_STANDARD |
標準永久磁碟類型。 |
PD_SSD |
SSD 永久磁碟類型。 |
PD_BALANCED |
平衡型永久磁碟類型。 |
PD_EXTREME |
極端永久磁碟類型。 |
EncryptionConfig
代表可套用至資源的自訂加密金鑰設定。這項操作會加密虛擬機器中的所有磁碟。
| JSON 表示法 |
|---|
{ "kmsKey": string } |
| 欄位 | |
|---|---|
kmsKey |
用於保護資源 (例如磁碟) 的客戶管理加密金鑰的 Cloud KMS 資源 ID。格式如下: |
RuntimeShieldedInstanceConfig
一組受防護的執行個體選項。請參閱使用支援的 Shielded VM 功能的映像檔。並非所有組合都有效。
| JSON 表示法 |
|---|
{ "enableSecureBoot": boolean, "enableVtpm": boolean, "enableIntegrityMonitoring": boolean } |
| 欄位 | |
|---|---|
enableSecureBoot |
定義執行個體是否已啟用安全啟動。 安全啟動功能會驗證所有啟動元件的數位簽章。如果簽章未通過驗證,啟動程序就會暫停,這樣即可確保系統執行的軟體均真實可信。預設為停用。 |
enableVtpm |
定義執行個體是否已啟用 vTPM。(預設為啟用)。 |
enableIntegrityMonitoring |
定義執行個體是否已啟用完整性監控。 啟用執行個體啟動完整性的監控和認證功能。驗證是根據完整性政策基準執行。這個基準最初是在建立執行個體時,從隱含信任的開機映像檔衍生而來。(預設為啟用)。 |
RuntimeAcceleratorConfig
可使用的硬體加速器類型定義。請參閱 Compute Engine AcceleratorTypes。範例:
nvidia-tesla-k80nvidia-tesla-p100nvidia-tesla-v100nvidia-tesla-p4nvidia-tesla-t4nvidia-tesla-a100
| JSON 表示法 |
|---|
{
"type": enum ( |
| 欄位 | |
|---|---|
type |
加速器型號。 |
coreCount |
這個加速器的核心數量。 |
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 虛擬工作站。 |
NicType
vNIC 驅動程式類型。預設值應為 UNSPECIFIED_NIC_TYPE。
| 列舉 | |
|---|---|
UNSPECIFIED_NIC_TYPE |
未指定類型。 |
VIRTIO_NET |
VIRTIO |
GVNIC |
GVNIC |
BootImage
這個類型沒有任何欄位。
執行階段使用的開機映像檔定義。用於簡化執行階段升級程序。
狀態
這個執行階段的狀態定義。
| 列舉 | |
|---|---|
STATE_UNSPECIFIED |
未指定狀態。 |
STARTING |
運算層正在啟動執行階段。目前無法使用。 |
PROVISIONING |
運算層正在安裝必要架構,並向 Notebook Proxy 註冊執行階段。無法使用。 |
ACTIVE |
目前執行階段正在執行中。即可開始使用。 |
STOPPING |
控制邏輯正在停止執行階段。無法使用。 |
STOPPED |
執行階段已停止。無法使用。 |
DELETING |
正在刪除執行階段。無法使用。 |
UPGRADING |
正在升級執行階段。無法使用。 |
INITIALIZING |
系統正在建立及設定執行階段。目前無法使用。 |
HealthState
執行階段子狀態。
| 列舉 | |
|---|---|
HEALTH_STATE_UNSPECIFIED |
執行階段子狀態不明。 |
HEALTHY |
已知執行階段處於健康狀態 (例如,重要精靈正在執行)。適用於「ACTIVE」狀態。 |
UNHEALTHY |
已知執行階段處於不正常的狀態 (例如重要常駐程式未執行)。適用於 ACTIVE 狀態。 |
AGENT_NOT_INSTALLED |
執行階段尚未安裝健康狀態監控代理程式。適用於「有效」狀態。 |
AGENT_NOT_RUNNING |
執行階段健康狀態監控代理程式未執行。適用於「有效」狀態。 |
RuntimeAccessConfig
指定 Runtime 的登入設定
| JSON 表示法 |
|---|
{
"accessType": enum ( |
| 欄位 | |
|---|---|
accessType |
這個執行個體的存取模式類型。 |
runtimeOwner |
建立後,這個執行階段的擁有者。格式: |
proxyUri |
僅供輸出。用於存取執行階段的 Proxy 端點。 |
RuntimeAccessType
存取執行階段的方式可能包括:驗證模式。目前僅支援單一使用者。
| 列舉 | |
|---|---|
RUNTIME_ACCESS_TYPE_UNSPECIFIED |
未指定存取權。 |
SINGLE_USER |
單一使用者登入。 |
SERVICE_ACCOUNT |
服務帳戶模式。在服務帳戶模式中,執行階段建立者會指定存在於消費者專案中的服務帳戶。使用「執行階段服務帳戶」欄位。存取執行階段的使用者必須具備 ActAs (服務帳戶使用者) 權限。 |
RuntimeSoftwareConfig
指定執行階段內軟體的選取和設定。要在執行階段設定的屬性。屬性鍵的格式為 key:value,例如:
idleShutdown: trueidleShutdownTimeout: 180enableHealthMonitoring: true
| JSON 表示法 |
|---|
{ "notebookUpgradeSchedule": string, "idleShutdownTimeout": integer, "installGpuDriver": boolean, "customGpuDriverPath": string, "postStartupScript": string, "kernels": [ { object ( |
| 欄位 | |
|---|---|
notebookUpgradeSchedule |
世界標準時間時區的 Cron 運算式,用於排定執行個體自動升級作業。請採用 cron 格式。 |
idleShutdownTimeout |
關閉執行階段前等待的時間 (以分鐘為單位)。預設值:180 分鐘 |
installGpuDriver |
自動安裝 Nvidia 驅動程式。預設值:True |
customGpuDriverPath |
指定儲存 GPU 驅動程式的自訂 Cloud Storage 路徑。如未指定,系統會自動從官方 GPU 驅動程式中選擇。 |
postStartupScript |
Bash 指令碼的路徑,會在筆記本執行個體完全啟動後自動執行。路徑必須是網址或 Cloud Storage 路徑 ( |
kernels[] |
選用。使用容器映像檔清單,做為筆記本執行個體中的 Kernel。 |
postStartupScriptBehavior |
開機後指令碼的行為。 |
enableHealthMonitoring |
驗證核心內部服務是否正在運作。預設值:True |
idleShutdown |
執行階段會在 idle_shutdown_time 後自動關機。預設值:True |
upgradeable |
僅供輸出。布林值,指出映像檔系列中是否有較新的映像檔。 |
disableTerminal |
布林值,指出是否提供 JupyterLab 終端機。預設值:False |
version |
僅輸出開機映像檔版本,例如 M100 (來自映像檔的發布標籤)。 |
mixerDisabled |
布林值,指出是否應停用混音器用戶端。預設值:False |
PostStartupScriptBehavior
開機後指令碼的行為。
| 列舉 | |
|---|---|
POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED |
未指定開機指令碼的行為。只會在建立時執行一次。 |
RUN_EVERY_START |
每次啟動時,都會執行建立期間提供的開機指令碼。 |
DOWNLOAD_AND_RUN_EVERY_START |
每次啟動時,下載並執行提供的開機指令碼。 |
RuntimeMetrics
包含執行階段精靈指標,例如 OS、核心和工作階段統計資料。
| JSON 表示法 |
|---|
{ "systemMetrics": { string: string, ... } } |
| 欄位 | |
|---|---|
systemMetrics |
僅供輸出。系統指標。 包含 |
RuntimeMigrationEligibility
RuntimeMigrationEligibility 代表從 GmN 遷移至 WbI 的可行性資訊。
| JSON 表示法 |
|---|
{ "warnings": [ enum ( |
| 欄位 | |
|---|---|
warnings[] |
僅供輸出。遷移期間,系統會預設某些設定。 |
errors[] |
僅供輸出。部分設定會導致 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 已設定開機後指令碼。請視需要提供遷移作業的 postStartupScriptOption。 |
SINGLE_USER |
這個 GmN 已設定為單一使用者模式。請視需要提供遷移作業的 serviceAccount 選項。 |
錯誤
如果出現遷移錯誤訊息,表示某些設定會導致 Google 商家檔案不符合自動遷移資格。必須手動遷移。
| 列舉 | |
|---|---|
ERROR_UNSPECIFIED |
預設類型。 |
CUSTOM_CONTAINER |
GmN 已設定自訂容器,因此無法遷移。 |
方法 |
|
|---|---|
|
在指定專案和位置中建立新的 Runtime。 |
|
刪除單一執行階段。 |
|
取得單一執行階段的詳細資料。 |
|
取得資源的存取控管政策。 |
|
列出指定專案和位置中的執行階段。 |
|
將現有執行階段遷移至新的 Workbench 執行個體。 |
|
更新筆記本執行階段設定。 |
|
回報及處理執行階段事件。 |
|
重設代管型 Notebook 執行階段。 |
|
設定指定資源的存取控管政策。 |
|
啟動代管型筆記本執行階段。 |
|
停止代管筆記本執行階段。 |
|
切換代管型筆記本執行階段。 |
|
傳回呼叫端對指定資源所擁有的權限。 |