REST Resource: projects.locations.instances

資源：執行個體

筆記本執行個體的定義。

JSON 表示法 
{
  "name": string,
  "proxyUri": string,
  "instanceOwners": [
    string
  ],
  "creator": string,
  "state": enum (State),
  "upgradeHistory": [
    {
      object (UpgradeHistoryEntry)
    }
  ],
  "id": string,
  "healthState": enum (HealthState),
  "healthInfo": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "disableProxyAccess": boolean,
  "labels": {
    string: string,
    ...
  },
  "thirdPartyProxyUrl": string,
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean,
  "enableThirdPartyIdentity": boolean,
  "enableManagedEuc": boolean,
  "enableDeletionProtection": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "gceSetup": {
    object (GceSetup)
  }
  // End of mutually exclusive fields.
}
欄位
name

string

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

string

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

string

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

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

string

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

enum (State)

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

object (UpgradeHistoryEntry)

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

string

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

enum (HealthState)

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

map (key: string, value: 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"
}

包含 "key": value 組合清單的物件，例如 { "name": "wrench", "mass": "1.3kg", "count": "3" }。
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"。
disableProxyAccess

boolean

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

map (key: string, value: string)

選用。要套用至這個執行個體的標籤。這些設定稍後可透過 instances.patch 方法修改。

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

string

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

選用。如果為 true，這個 Workbench 執行個體就會啟用防刪除功能。如果為 false，系統會停用這個 Workbench 執行個體的防刪除功能。
設定筆記本執行個體。以下列出互斥欄位。回應中最多會設定一個欄位：
gceSetup

object (GceSetup)

選用。筆記本的 Compute Engine 設定。使用筆記本定義的欄位。
互斥欄位的結尾。

GceSetup

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

JSON 表示法 
{
  "machineType": string,
  "minCpuPlatform": string,
  "acceleratorConfigs": [
    {
      object (AcceleratorConfig)
    }
  ],
  "serviceAccounts": [
    {
      object (ServiceAccount)
    }
  ],
  "bootDisk": {
    object (BootDisk)
  },
  "dataDisks": [
    {
      object (DataDisk)
    }
  ],
  "shieldedInstanceConfig": {
    object (ShieldedInstanceConfig)
  },
  "networkInterfaces": [
    {
      object (NetworkInterface)
    }
  ],
  "disablePublicIp": boolean,
  "tags": [
    string
  ],
  "metadata": {
    string: string,
    ...
  },
  "systemMetadata": {
    string: string,
    ...
  },
  "enableIpForwarding": boolean,
  "gpuDriverConfig": {
    object (GPUDriverConfig)
  },
  "confidentialInstanceConfig": {
    object (ConfidentialInstanceConfig)
  },
  "instanceId": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "vmImage": {
    object (VmImage)
  },
  "containerImage": {
    object (ContainerImage)
  }
  // End of mutually exclusive fields.
}
欄位
machineType

string

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

string

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

object (AcceleratorConfig)

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

object (ServiceAccount)

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

object (BootDisk)

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

object (DataDisk)

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

object (ShieldedInstanceConfig)

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

object (NetworkInterface)

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

boolean

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

string

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

map (key: string, value: string)

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

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

map (key: string, value: string)

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

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

boolean

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

object (GPUDriverConfig)

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

object (ConfidentialInstanceConfig)

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

string

僅供輸出。Compute Engine 執行個體資源的專屬 ID。
映像檔類型，可以是 VM 映像檔或容器映像檔。以下列出互斥欄位。回應中最多會設定一個欄位：
vmImage

object (VmImage)

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

object (ContainerImage)

選用。使用容器映像檔啟動 Notebook 執行個體。
互斥欄位的結尾。

AcceleratorConfig

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

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

enum (AcceleratorType)

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

string (int64 format)

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

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。

ServiceAccount

做為身分的服務帳戶。

JSON 表示法 
{
  "email": string,
  "scopes": [
    string
  ]
}
欄位
email

string

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

string

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

VmImage

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

JSON 表示法 
{
  "project": string,
  "imageDescription": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "name": string,
  "family": string
  // End of mutually exclusive fields.
}
欄位
project

string

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

string

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

string

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

string

選用。使用這個 VM 映像檔系列尋找映像檔，系統會使用這個系列中最新的映像檔。
互斥欄位的結尾。

ContainerImage

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

JSON 表示法 
{
  "repository": string,
  "tag": string
}
欄位
repository

string

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

string

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

BootDisk

開機磁碟的定義。

JSON 表示法 
{
  "diskSizeGb": string,
  "diskType": enum (DiskType),
  "diskEncryption": enum (DiskEncryption),
  "kmsKey": string
}
欄位
diskSizeGb

string (int64 format)

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

enum (DiskType)

選用。指出磁碟類型。
diskEncryption

enum (DiskEncryption)

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

string

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

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

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 永久磁碟類型。可做為開機磁碟或資料磁碟。

DiskEncryption

磁碟加密選項的定義。

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

DataDisk

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

JSON 表示法 
{
  "diskSizeGb": string,
  "diskType": enum (DiskType),
  "diskEncryption": enum (DiskEncryption),
  "kmsKey": string,
  "resourcePolicies": [
    string
  ]
}
欄位
diskSizeGb

string (int64 format)

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

enum (DiskType)

選用。指出磁碟類型。
diskEncryption

enum (DiskEncryption)

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

string

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

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

string

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

ShieldedInstanceConfig

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

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

boolean

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

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

boolean

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

boolean

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

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

NetworkInterface

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

JSON 表示法 
{
  "network": string,
  "subnet": string,
  "nicType": enum (NicType),
  "accessConfigs": [
    {
      object (AccessConfig)
    }
  ],
  "internalIp": string
}
欄位
network

string

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

string

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

enum (NicType)

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

object (AccessConfig)

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

string

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

NicType

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

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

AccessConfig

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

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

string

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

GPUDriverConfig

GPU 驅動程式設定

JSON 表示法 
{
  "enableGpuDriver": boolean,
  "customGpuDriverPath": string
}
欄位
enableGpuDriver

boolean

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

string

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

ConfidentialInstanceConfig

一組機密執行個體選項。

JSON 表示法 
{
  "confidentialInstanceType": enum (ConfidentialInstanceType)
}
欄位
confidentialInstanceType

enum (ConfidentialInstanceType)

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

ConfidentialInstanceType

機密執行個體的類型。

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

狀態

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

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

UpgradeHistoryEntry

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

JSON 表示法 
{
  "snapshot": string,
  "vmImage": string,
  "containerImage": string,
  "framework": string,
  "version": string,
  "state": enum (State),
  "createTime": 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"。
action

enum (Action)

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

string

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

狀態

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

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

動作

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

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

HealthState

執行個體的健康狀態。

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

方法

checkUpgradability

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

create

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

delete

 刪除單一執行個體。

diagnose

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

get

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

getConfig

 傳回各種設定參數。

getIamPolicy

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

list

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

patch

 UpdateInstance 會更新 Instance。

reset

 重設筆記本執行個體。

resizeDisk

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

restore

 RestoreInstance 會從 BackupSource 還原 Instance。

rollback

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

setIamPolicy

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

start

 啟動筆記本執行個體。

stop

 停止筆記本執行個體。

testIamPermissions

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

upgrade

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