REST Resource: projects.locations.instances

資源：執行個體

筆記本執行個體的定義。

JSON 表示法 
{
  "name": string,
  "postStartupScript": string,
  "proxyUri": string,
  "instanceOwners": [
    string
  ],
  "serviceAccount": string,
  "serviceAccountScopes": [
    string
  ],
  "machineType": string,
  "acceleratorConfig": {
    object (AcceleratorConfig)
  },
  "state": enum (State),
  "installGpuDriver": boolean,
  "customGpuDriverPath": string,
  "bootDiskType": enum (DiskType),
  "bootDiskSizeGb": string,
  "dataDiskType": enum (DiskType),
  "dataDiskSizeGb": string,
  "noRemoveDataDisk": boolean,
  "diskEncryption": enum (DiskEncryption),
  "kmsKey": string,
  "disks": [
    {
      object (Disk)
    }
  ],
  "shieldedInstanceConfig": {
    object (ShieldedInstanceConfig)
  },
  "noPublicIp": boolean,
  "noProxyAccess": boolean,
  "network": string,
  "subnet": string,
  "labels": {
    string: string,
    ...
  },
  "metadata": {
    string: string,
    ...
  },
  "tags": [
    string
  ],
  "upgradeHistory": [
    {
      object (UpgradeHistoryEntry)
    }
  ],
  "nicType": enum (NicType),
  "reservationAffinity": {
    object (ReservationAffinity)
  },
  "creator": string,
  "canIpForward": boolean,
  "createTime": string,
  "updateTime": string,
  "instanceMigrationEligibility": {
    object (InstanceMigrationEligibility)
  },

  // Union field environment can be only one of the following:
  "vmImage": {
    object (VmImage)
  },
  "containerImage": {
    object (ContainerImage)
  }
  // End of list of possible types for union field environment.
  "migrated": boolean
}
欄位
name

string

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

string

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

string

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

string

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

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

string

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

如未指定，則會使用 Compute Engine 預設服務帳戶。
serviceAccountScopes[]

string

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

如未指定，系統會定義下列範圍： - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email 如未使用預設範圍，您至少需要： https://www.googleapis.com/auth/compute
machineType

string

這是必要旗標，這個執行個體的 Compute Engine 機型。
acceleratorConfig

object (AcceleratorConfig)

這個執行個體使用的硬體加速器。如果您使用加速器，請確認設定有足夠的 vCPU 和記憶體來支援所選的 machineType。
state

enum (State)

僅供輸出。這個執行個體的狀態。
installGpuDriver

boolean

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

string

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

enum (DiskType)

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

string (int64 format)

僅供輸入。附加至這個執行個體的開機磁碟大小 (以 GB 為單位)，上限為 64,000 GB (64 TB)。建議的最小值為 100 GB。如未指定，預設值為 100。
dataDiskType

enum (DiskType)

僅供輸入。附加至這個執行個體的資料磁碟類型，預設為標準永久磁碟 (PD_STANDARD)。
dataDiskSizeGb

string (int64 format)

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

boolean

僅供輸入。如果為 true，刪除執行個體時不會自動刪除資料磁碟。
diskEncryption

enum (DiskEncryption)

僅供輸入。開機磁碟和資料磁碟使用的磁碟加密方法，預設為 GMEK。
kmsKey

string

僅供輸入。用於加密磁碟的 KMS 金鑰，僅適用於 diskEncryption 為 CMEK 的情況。格式：projects/{projectId}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

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

object (Disk)

僅供輸出。連結至筆記本執行個體的磁碟。
shieldedInstanceConfig

object (ShieldedInstanceConfig)

選用。Shielded VM 設定。使用支援的受防護 VM 功能的映像檔。
noPublicIp

boolean

如果為 true，系統就不會為這個執行個體指派外部 IP。
noProxyAccess

boolean

如為 true，筆記本執行個體就不會向 Proxy 註冊。
network

string

這個執行個體所在的虛擬私有雲名稱。格式：projects/{projectId}/global/networks/{network_id}
subnet

string

這個執行個體所在的子網路名稱。格式：projects/{projectId}/regions/{region}/subnetworks/{subnetwork_id}
labels

map (key: string, value: string)

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

包含 "key": value 組合清單的物件，範例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
metadata

map (key: string, value: string)

要套用至這個執行個體的自訂中繼資料。舉例來說，如要指定自動備份的 Cloud Storage 值區，可以使用 gcs-data-bucket 中繼資料標記。格式："--metadata=gcs-data-bucket=BUCKET"。

包含 "key": value 組合清單的物件，範例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
tags[]

string

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

object (UpgradeHistoryEntry)

這個執行個體的升級記錄。
nicType

enum (NicType)

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

object (ReservationAffinity)

選用。選填的預留項目相依性。設定這個欄位會將指定的區域運算預留項目套用至這個 Notebook 執行個體。
creator

string

僅供輸出。傳送原始 instances.create 要求的實體電子郵件地址。
canIpForward

boolean

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

string (Timestamp format)

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

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

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

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
instanceMigrationEligibility

object (InstanceMigrationEligibility)

僅供輸出。檢查從 UmN 遷移至 WbI 的可行性。
聯集欄位 environment。環境類型，可以是 VM 映像檔或容器映像檔。environment 只能是下列其中一個設定：
vmImage

object (VmImage)

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

object (ContainerImage)

使用容器映像檔啟動筆記本執行個體。
migrated

boolean

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

AcceleratorConfig

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

JSON 表示法 
{
  "type": enum (AcceleratorType),
  "coreCount": string
}
欄位
type

enum (AcceleratorType)

這個加速器的類型。
coreCount

string (int64 format)

這個加速器的核心數。

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。

狀態

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

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

DiskType

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

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

DiskEncryption

磁碟加密選項的定義。

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

磁碟

附加至執行個體的磁碟資源。

JSON 表示法 
{
  "autoDelete": boolean,
  "boot": boolean,
  "deviceName": string,
  "diskSizeGb": string,
  "guestOsFeatures": [
    {
      object (GuestOsFeature)
    }
  ],
  "index": string,
  "interface": string,
  "kind": string,
  "licenses": [
    string
  ],
  "mode": string,
  "source": string,
  "type": string
}
欄位
autoDelete

boolean

指出是否要在刪除執行個體時自動刪除磁碟 (但從執行個體卸離磁碟時不會刪除)。
boot

boolean

表示這是開機磁碟。虛擬機器會使用磁碟的第一個分割區做為根檔案系統。
deviceName

string

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

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

string (int64 format)

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

object (GuestOsFeature)

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

string (int64 format)

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

string

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

  • NVME
  • SCSI
kind

string

資源類型。附加磁碟一律為 compute#attachedDisk。
licenses[]

string

公開顯示的授權清單。僅供 Google 使用。授權代表公開和市集映像檔的帳單和匯總用量資料。
mode

string

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

  • READ_ONLY
  • READ_WRITE
source

string

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

string

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

  • PERSISTENT
  • SCRATCH

GuestOsFeature

開機磁碟的客體 OS 功能。

JSON 表示法 
{
  "type": string
}
欄位
type

string

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

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

ShieldedInstanceConfig

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

JSON 表示法 
{
  "enableSecureBoot": boolean,
  "enableVtpm": boolean,
  "enableIntegrityMonitoring": boolean
}
欄位
enableSecureBoot

boolean

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

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

boolean

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

boolean

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

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

UpgradeHistoryEntry

VM 映像檔升級記錄項目。

JSON 表示法 
{
  "snapshot": string,
  "vmImage": string,
  "containerImage": string,
  "framework": string,
  "version": string,
  "state": enum (State),
  "createTime": string,
  "targetImage": string,
  "action": enum (Action),
  "targetVersion": string
}
欄位
snapshot

string

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

string

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

string

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

string

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

string

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

enum (State)

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

string (Timestamp format)

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

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
targetImage
(deprecated)

string

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

enum (Action)

準備開拍了！復原或升級。
targetVersion

string

目標 VM 版本，例如 m63。

狀態

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

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

動作

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

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

NicType

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

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

ReservationAffinity

預留項目相依性，用於使用區域預留項目。

JSON 表示法 
{
  "consumeReservationType": enum (Type),
  "key": string,
  "values": [
    string
  ]
}
欄位
consumeReservationType

enum (Type)

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

string

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

string

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

類型

指出是否要使用預留容量。

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

InstanceMigrationEligibility

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

JSON 表示法 
{
  "warnings": [
    enum (Warning)
  ],
  "errors": [
    enum (Error)
  ]
}
欄位
warnings[]

enum (Warning)

僅供輸出。遷移期間，系統會將特定設定設為預設值。
errors[]

enum (Error)

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

警告

遷移警告訊息表示遷移期間，系統會將特定設定設為預設值。

列舉
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 設有 noRemoveDataDisk，但這項設定已不再適用於 WbI。
GCS_BACKUP 這個 UmN 設為採用 Cloud Storage 備份功能，但這項功能已不適用於 WbI。
POST_STARTUP_SCRIPT 這個 UmN 是透過開機後指令碼設定。請視需要提供遷移作業的 postStartupScriptOption。

錯誤

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

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

方法

create

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

delete

 刪除單一執行個體。

diagnose

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

get

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

getIamPolicy

 取得資源的存取控管政策。

getInstanceHealth

 檢查筆記本執行個體的健康狀態是否良好。

isUpgradeable

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

list

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

migrate

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

register

 向 Notebooks API 伺服器註冊現有的舊版筆記本執行個體。

report

 允許筆記本執行個體向 Notebooks API 伺服器回報最新執行個體資訊。

reset

 重設筆記本執行個體。

rollback

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

setAccelerator

 更新單一執行個體的客層加速器。

setIamPolicy

 設定指定資源的存取控管政策。

setLabels

 取代執行個體的所有標籤。

setMachineType

 更新單一執行個體的機型。

start

 啟動筆記本執行個體。

stop

 停止筆記本執行個體。

testIamPermissions

 傳回呼叫端對指定資源所擁有的權限。

updateConfig

 更新 Notebook 執行個體設定。

updateMetadataItems

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

updateShieldedInstanceConfig

 更新單一執行個體的受防護執行個體設定。

upgrade

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