Package google.cloud.notebooks.v1

string

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

string

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

string

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

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

• notebooks.environments.create

string

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

Environment

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

string

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

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

• notebooks.executions.create

string

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

Execution

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

string

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

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

• notebooks.instances.create

string

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

Instance

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

string

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

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

• notebooks.runtimes.create

string

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

Runtime

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

string

冪等要求 UUID。

string

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

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

• notebooks.schedules.create

string

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

Schedule

這是必要旗標，要建立的排程。

string

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

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

• notebooks.environments.delete

string

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

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

• notebooks.executions.delete

string

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

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

• notebooks.instances.delete

string

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

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

• notebooks.runtimes.delete

string

冪等要求 UUID。

string

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

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

• notebooks.schedules.delete

string

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

DiagnosticConfig

這是必要旗標，定義用於執行診斷工具的旗標

int32

選用。作業逾時前的等待時間上限 (分鐘)。

string

這是必要旗標，使用者 Cloud Storage bucket 位置 (必填)。必須使用路徑前置字串 (gs://$GCS_BUCKET) 格式。

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

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

string

選用。定義 Cloud Storage 值區中的相對儲存路徑，診斷記錄會寫入該路徑：預設路徑為 Cloud Storage 值區的根目錄 (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz)。記錄檔寫入的完整路徑範例：gs://$GCS_BUCKET/$RELATIVE_PATH/

bool

選用。啟用旗標，以便修復執行個體的服務

bool

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

bool

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

string

用來保護資源 (例如磁碟) 的客戶管理加密金鑰的 Cloud KMS 資源 ID。格式如下：projects/{PROJECT_ID}/locations/{REGION}/keyRings/{KEY_RING_NAME}/cryptoKeys/{KEY_NAME}

string

僅供輸出。這個環境的名稱。格式：projects/{project_id}/locations/{location}/environments/{environment_id}

string

這個環境在使用者介面中的顯示名稱。

string

這個環境的簡短說明。

string

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

Timestamp

僅供輸出。建立這個環境的時間。

VmImage

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

ContainerImage

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

Timestamp

事件回報時間。

EventType

事件類型。

map<string, string>

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

ExecutionTemplate

執行中繼資料，包括名稱、硬體規格、區域、標籤等。

string

僅供輸出。執行的資源名稱。格式：projects/{project_id}/locations/{location}/executions/{execution_id}

string

僅供輸出。用於使用者介面的名稱。名稱只能包含英數字元和底線「_」。

string

簡要說明這項執行作業。

Timestamp

僅供輸出。執行個體化的執行時間。

Timestamp

僅供輸出。上次更新執行作業的時間。

State

僅供輸出。基礎 AI Platform 工作的狀態。

string

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

string

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

ScaleTier

這是必要旗標，用於執行筆記本的硬體規模層級。[已淘汰] 即將停用。因為目前僅支援 CUSTOM。

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 訓練的特殊設定選項。

SchedulerAcceleratorConfig

執行筆記本時使用的硬體設定 (數量和加速器類型)。

map<string, string>

執行作業的標籤。如果執行作業已排定時間，則會納入「nbs-scheduled」欄位。否則為立即執行，且包含的欄位為「nbs-immediate」。使用欄位可有效率地為各種執行類型建立索引。

string

要執行的筆記本檔案路徑。必須位於 Google Cloud Storage bucket 中。格式：gs://{bucket_name}/{folder}/{notebook_file_name} 示例：gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb

string

DLVM 的容器映像檔 URI。範例：'gcr.io/deeplearning-platform-release/base-cu100'。如需更多範例，請參閱：https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container

string

要寫入的筆記本資料夾路徑。必須是 Google Cloud Storage 值區路徑。格式：gs://{bucket_name}/{folder} 例如：gs://notebook_user/scheduled_notebooks

string

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

string

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

string

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

JobType

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

string

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

string

Agent Platform [TensorBoard] 資源的名稱，執行作業會將 TensorBoard 記錄上傳至該資源。格式：projects/{project}/locations/{location}/tensorboards/{tensorboard}

DataprocParameters

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

VertexAIParameters

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

string

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

SchedulerAcceleratorType

這個加速器的類型。

int64

這個加速器的核心數。

string

應與工作對等互連的 Compute Engine 網路全名。例如，projects/12345/global/networks/myVPC。格式為 projects/{project}/global/networks/{network}。其中 {project} 是專案編號，如 12345 所示，{network} 則是網路名稱。

必須已針對網路設定私人服務連線。如果未指定，工作就不會與任何網路對等互連。

map<string, string>

環境變數。最多可指定 100 個環境變數，且不得重複。範例：GCP_BUCKET=gs://my-bucket/samples/

string

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

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

• notebooks.environments.get

string

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

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

• notebooks.executions.get

string

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

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

• notebooks.instances.getHealth

HealthState

僅供輸出。執行階段健康狀態。

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

string

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

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

• notebooks.instances.get

string

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

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

• notebooks.runtimes.get

string

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

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

• notebooks.schedules.get

string

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

string

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

string

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

string

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

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

string

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

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

string

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

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

string

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

AcceleratorConfig

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

State

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

bool

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

string

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

DiskType

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

int64

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

DiskType

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

int64

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

bool

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

DiskEncryption

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

string

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

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

Disk

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

ShieldedInstanceConfig

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

bool

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

bool

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

string

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

string

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

map<string, string>

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

map<string, string>

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

string

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

UpgradeHistoryEntry

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

NicType

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

ReservationAffinity

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

string

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

bool

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

Timestamp

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

Timestamp

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

InstanceMigrationEligibility

僅供輸出。檢查從 UmN 遷移至 WbI 的可行性。

VmImage

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

ContainerImage

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

bool

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

AcceleratorType

這個加速器的類型。

int64

這個加速器的核心數。

bool

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

bool

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

string

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

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

int64

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

GuestOsFeature

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

int64

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

string

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

• NVME
• SCSI

string

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

string

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

string

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

• READ_ONLY
• READ_WRITE

string

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

string

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

• PERSISTENT
• SCRATCH

string

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

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

bool

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

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

bool

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

bool

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

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

string

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

string

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

string

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

string

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

string

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

State

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

Timestamp

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

string

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

Action

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

string

目標 VM 版本，例如 m63。

string

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

bool

確認核心內部服務是否正在運作。

Warning

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

Error

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

string

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

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

• notebooks.instances.checkUpgradability

UpgradeType

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

bool

執行個體是否可升級。

string

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

string

升級的其他資訊。

string

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

string

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

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

• notebooks.environments.list

int32

清單呼叫傳回的大小上限。

string

先前傳回的網頁權杖，可用於從上次結果繼續列出項目。

Environment

傳回的環境清單。

string

頁面符記，可用於在下一次清單呼叫中，從上一個結果繼續列出。

string

無法連線的位置。

string

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

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

• notebooks.executions.list

int32

清單呼叫傳回的大小上限。

string

先前傳回的網頁權杖，可用於從上次結果繼續列出項目。

string

篩選器已套用至產生的執行作業。目前僅支援依指定 schedule_id 篩選執行作業。格式：schedule_id=<Schedule_ID>

string

依欄位排序。

Execution

傳回的執行個體清單。

string

頁面符記，可用於在下一次清單呼叫中，從上一個結果繼續列出。

string

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

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

string

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

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

• notebooks.instances.list

int32

清單呼叫傳回的大小上限。

string

先前傳回的網頁權杖，可用於從上次結果繼續列出項目。

string

選用。將結果排序。支援的值為「name」、「name desc」或「」(未排序)。

string

選用。清單篩選器。

Instance

傳回的執行個體清單。

string

頁面符記，可用於在下一次清單呼叫中，從上一個結果繼續列出。

string

無法連線的位置。例如 ['us-west1-a', 'us-central1-b']。ListInstancesResponse 只會包含執行個體或無法連線的執行個體，

string

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

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

• notebooks.runtimes.list

int32

清單呼叫傳回的大小上限。

string

先前傳回的網頁權杖，可用於從上次結果繼續列出項目。

string

選用。將結果排序。支援的值為「name」、「name desc」或「」(未排序)。

string

選用。清單篩選器。

Runtime

傳回的執行階段清單。

string

頁面符記，可用於在下一次清單呼叫中，從上一個結果繼續列出。

string

無法連線的位置。例如 ['us-west1', 'us-central1']。ListRuntimesResponse 只會包含執行階段或無法連線的項目，

string

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

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

• notebooks.schedules.list

int32

清單呼叫傳回的大小上限。

string

先前傳回的網頁權杖，可用於從上次結果繼續列出項目。

string

篩選器已套用至產生的行程。

string

用於排序結果的欄位。

Schedule

傳回的執行個體清單。

string

頁面符記，可用於在下一次清單呼叫中，從上一個結果繼續列出。

string

無法聯絡的行程。例如：

['projects/{project_id}/location/{location}/schedules/monthly_digest',
 'projects/{project_id}/location/{location}/schedules/weekly_sentiment']

bool

選用。僅供輸出。指定是否要在刪除執行個體時自動刪除磁碟 (但從執行個體卸離磁碟時不會刪除)。

bool

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

string

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

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

RuntimeGuestOsFeature

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

int32

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

LocalDiskInitializeParams

僅供輸入。指定要與新執行個體一併建立的新磁碟參數。使用初始化參數建立開機磁碟或連結至新執行個體的本機 SSD。

這項屬性與來源資源互斥，您只能定義其中一項，不能同時定義兩者。

string

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

• NVME
• SCSI

string

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

string

僅供輸出。任何有效的公開顯示執照。

string

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

• READ_ONLY
• READ_WRITE

string

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

string

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

• PERSISTENT
• SCRATCH

string

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

有效值：

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

string

選用。建立磁碟時請提供這項屬性。

string

選用。指定磁碟名稱。如未指定，系統預設會使用執行個體的名稱。如果指定區域/地區中已有執行個體名稱的磁碟，系統會自動產生新名稱。

int64

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

DiskType

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

map<string, string>

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

string

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

如要授權，必須具備指定資源 name 的下列一或多項 IAM 權限：

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

PostStartupScriptOption

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

string

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

如要授權，必須具備指定資源 name 的下列一或多項 IAM 權限：

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

string

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

string

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

string

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

string

選用。冪等要求 UUID。

PostStartupScriptOption

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

Timestamp

作業的建立時間。

Timestamp

作業完成執行的時間。

string

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

string

作業執行的動詞名稱。

string

作業狀態 (如有)。

bool

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

string

用於啟動作業的 API 版本。

string

這項作業的 API 端點名稱。

string

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

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

• notebooks.instances.create

string

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

string

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

string

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

map<string, string>

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

string

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

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

• iam.permissions.none

string

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

Event

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

Type

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

string

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

string

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

string

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

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

• notebooks.instances.reset

string

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

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

• notebooks.runtimes.reset

string

冪等要求 UUID。

string

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

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

• iam.permissions.none

string

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

string

僅供輸出。執行階段的資源名稱。格式：projects/{project}/locations/{location}/runtimes/{runtimeId}

State

僅供輸出。執行階段狀態。

HealthState

僅供輸出。執行階段健康狀態。

RuntimeAccessConfig

存取執行階段的設定。

RuntimeSoftwareConfig

執行階段內軟體的設定。

RuntimeMetrics

僅供輸出。內含執行階段 Daemon 指標，例如服務狀態和 JupyterLab 統計資料。

Timestamp

僅供輸出。執行階段建立時間。

Timestamp

僅供輸出。執行階段更新時間。

map<string, string>

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

RuntimeMigrationEligibility

僅供輸出。檢查從 GmN 遷移至 WbI 的可行性。

VirtualMachine

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

bool

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

AcceleratorType

加速器型號。

int64

這個加速器的核心數。

RuntimeAccessType

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

string

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

string

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

map<string, string>

僅供輸出。系統指標。

Warning

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

Error

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

bool

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

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

bool

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

bool

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

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

string

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

int32

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

bool

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

string

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

string

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

ContainerImage

選用。使用容器映像檔清單，在 Notebook 執行個體中做為 Kernel。

PostStartupScriptBehavior

開機後指令碼的行為。

bool

驗證核心內部服務是否正在執行。預設值：True

bool

執行階段會在 idle_shutdown_time 後自動關機。預設值：True

bool

僅供輸出。布林值，指出映像檔系列中是否有較新的映像檔。

bool

布林值，指出是否提供 JupyterLab 終端機。預設值：False

string

僅供輸出。開機映像檔版本，例如 M100，來自映像檔的發布標籤。

bool

指出是否應停用混音器用戶端的布林值。預設值：False

string

僅供輸出。這項排程的名稱。格式：projects/{project_id}/locations/{location}/schedules/{schedule_id}

string

僅供輸出。顯示名稱用於使用者介面。名稱只能包含英數字元、連字號 - 和底線 _。

string

這個環境的簡短說明。

State

string

工作執行的時間表 (Cron-tab 格式)。格式：分鐘、小時、月份中的日期、月份、星期幾，例如 0 0 * * WED = 每週三。更多範例：https://crontab.guru/examples.html

string

cron_schedule 的時區。這個欄位的值必須是 tz 資料庫中的時區名稱。TZ 資料庫：https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

請注意，部分時區包含日光節約時間的規定。日光節約時間規則取決於所選時區。如要使用世界標準時間，請使用字串「utc」。如未指定時區，系統會預設使用世界標準時間 (亦稱為格林威治標準時間)。

Timestamp

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

Timestamp

僅供輸出。上次更新時間表的日期。

ExecutionTemplate

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

Execution

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

string

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

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

• notebooks.instances.setAccelerator

AcceleratorType

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

int64

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

string

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

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

• notebooks.instances.setLabels

map<string, string>

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

string

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

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

• notebooks.instances.setMachineType

string

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

string

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

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

• notebooks.instances.start

string

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

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

• notebooks.runtimes.start

string

冪等要求 UUID。

string

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

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

• notebooks.instances.stop

string

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

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

• notebooks.runtimes.stop

string

冪等要求 UUID。

string

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

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

• notebooks.runtimes.switch

string

機型。

RuntimeAcceleratorConfig

加速器設定。

string

冪等要求 UUID。

string

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

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

• notebooks.instances.updateConfig

InstanceConfig

要更新的執行個體設定。

string

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

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

• notebooks.instances.updateConfig

map<string, string>

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

map<string, string>

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

Runtime

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

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

• notebooks.runtimes.update

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

string

冪等要求 UUID。

string

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

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

• notebooks.instances.updateShieldInstanceConfig

ShieldedInstanceConfig

要更新的 ShieldedInstance 設定。

string

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

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

• notebooks.instances.upgrade

UpgradeType

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

string

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

string

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

VirtualMachineConfig

虛擬機器設定。

string

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

string

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

ContainerImage

選用。使用容器映像檔清單，在 Notebook 執行個體中做為 Kernel。

LocalDisk

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

EncryptionConfig

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

RuntimeShieldedInstanceConfig

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

RuntimeAcceleratorConfig

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

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 (需要網路和子網路)。需要設定私人服務連線。

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

bool

選用。如果為 true，執行階段就只會有內部 IP 位址。根據預設，執行階段不會限制使用內部 IP 位址，且每個 VM 都會獲派臨時外部 IP 位址。這項internal_ip_only限制只能針對已啟用子網路的網路啟用，且所有依附元件都必須設定為可在沒有外部 IP 位址的情況下存取。

string

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

map<string, string>

僅供輸出。Compute Engine 訪客屬性。(請參閱「專案和執行個體訪客屬性」)。

map<string, string>

選用。要新增至虛擬機器的 Compute Engine 中繼資料項目。(請參閱「專案和執行個體中繼資料」)。

map<string, string>

選用。要與這個執行階段建立關聯的標籤。標籤鍵必須包含 1 到 63 個字元，且必須符合 RFC 1035。標籤值可以空白，但如果存在，則必須包含 1 到 63 個字元，且必須符合 RFC 1035。一個叢集最多只能有 32 個相關聯的標籤。

NicType

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

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

BootImage

選用。用於執行階段升級的開機映像檔中繼資料。

string

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

string

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

string

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