Package google.cloud.notebooks.v2

索引

NotebookService

Workbench 笔记本实例的 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 恢复实例。

授权范围

需要以下 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 会更新实例。

授权范围

需要以下 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

虚拟机实例的加速器配置硬件加速器的定义。请注意，系统不会检查 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

可选。附加到相应虚拟机实例的磁盘大小（以 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 存储桶位置（必需）。必须采用路径前缀 (gs://$GCS_BUCKET) 进行格式设置。

权限：用户管理型笔记本：- storage.buckets.writer：必须授予给附加到虚拟机的项目的服务账号。Google 管理的笔记本：- storage.buckets.writer：必须根据身份验证模式授予项目的服务账号或附加到虚拟机的用户凭据。

Cloud Storage 存储桶日志文件将写入 gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
relative_path

string

可选。定义 Cloud Storage 存储桶中将写入诊断日志的相对存储路径：默认路径将是 Cloud Storage 存储桶的根目录 (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 在此虚拟机实例上安装 GPU 驱动程序。如果此字段为空或设置为 false，则不会安装 GPU 驱动程序。仅适用于带有 GPU 的实例。
custom_gpu_driver_path

string

可选。指定存储 GPU 驱动程序的自定义 Cloud Storage 路径。如果未指定，我们会自动从官方 GPU 驱动程序中选择。

GceSetup

有关如何在资源和身份之外配置虚拟机实例的定义。

字段
machine_type

string

可选。虚拟机实例的机器类型。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

可选。充当虚拟机实例身份的服务账号。目前仅支持一个服务账号。
boot_disk

BootDisk

可选。虚拟机的启动磁盘。
data_disks[]

DataDisk

可选。挂接到虚拟机实例的数据磁盘。目前仅支持一个数据磁盘。
shielded_instance_config

ShieldedInstanceConfig

可选。安全强化型虚拟机配置。使用受支持的安全强化型虚拟机功能的映像。
network_interfaces[]

NetworkInterface

可选。虚拟机的网络接口。仅支持一个接口。
disable_public_ip

bool

可选。如果为 true，则不会为此虚拟机实例分配任何外部 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。映像的类型；可以是虚拟机映像，也可以是容器映像。image 只能是下列其中一项：
vm_image

VmImage

可选。使用 Compute Engine 虚拟机映像启动笔记本实例。
container_image

ContainerImage

可选。使用容器映像启动笔记本实例。

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 实例未安装健康状况监控代理。适用于 ACTIVE 状态。
AGENT_NOT_RUNNING 实例健康状况监控代理未运行。适用于 ACTIVE 状态。

ImageRelease

ConfigImage 表示可用于创建 WbI 的映像版本

字段
image_name

string

仅限输出。映像的名称，格式为 workbench-instances-vYYYYmmdd--
release_name

string

仅限输出。表单 m123 的图片发布
image_family

string

仅限输出。相应映像的映像系列。（例如：workbench-instances 或 workbench-2603）
description

string

仅限输出。图片的说明。

实例

笔记本实例的定义。

字段
name

string

仅限输出。标识符。相应笔记本实例的名称。格式：projects/{project_id}/locations/{location}/instances/{instance_id}
proxy_uri

string

仅限输出。用于访问 Jupyter 笔记本的代理端点。
instance_owners[]

string

可选。创建后相应实例的所有者。格式：alias@example.com

目前仅支持一位所有者。如果未指定，则虚拟机实例的服务账号的所有服务账号用户都可以使用该实例。
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，则笔记本实例不会向代理注册。
labels

map<string, string>

可选。要应用于此实例的标签。这些值稍后可以通过 UpdateInstance 方法进行修改。
third_party_proxy_url

string

仅限输出。用于访问 Jupyter 笔记本的员工池代理端点。
satisfies_pzs

bool

仅限输出。预留以供将来用于区域分离。
satisfies_pzi

bool

仅限输出。预留以供将来用于可用区隔离。
enable_third_party_identity

bool

可选。用于指定笔记本是否可通过第三方身份提供方进行访问的标志。
enable_managed_euc

bool

可选。用于为实例启用受管理的最终用户凭证的标志。
enable_deletion_protection

bool

可选。如果为 true，则为此工作台实例启用防删除保护。如果为 false，则会为此工作平台实例停用防删除保护。
联合字段 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

连接到虚拟机的网络接口资源的定义。

字段
network

string

可选。相应虚拟机实例所在的 VPC 的名称。格式：projects/{project_id}/global/networks/{network_id}
subnet

string

可选。相应虚拟机实例所在的子网的名称。格式：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 恢复笔记本实例。

字段
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

一组受防护的实例选项。请参阅使用受支持的安全强化型虚拟机功能的映像。并非所有组合都有效。

字段
enable_secure_boot

bool

可选。定义虚拟机实例是否已启用安全启动。

安全启动会验证所有启动组件的数字签名，并在签名验证失败时停止启动过程，从而有助于确保系统仅运行正版软件。默认情况下，该环境处于停用状态。
enable_vtpm

bool

可选。定义虚拟机实例是否已启用 vTPM。
enable_integrity_monitoring

bool

可选。定义虚拟机实例是否已启用完整性监控。

启用对虚拟机实例的启动完整性的监控和证明。证明是针对完整性政策基准执行的。此基准最初是在创建虚拟机实例时从隐式信任的启动映像派生出来的。

快照

快照表示用于恢复 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 控制逻辑是安装所需框架并将实例注册到笔记本代理
ACTIVE 实例正在运行。
STOPPING 控制逻辑正在停止实例。
STOPPED 实例已停止。
DELETED 实例已删除。
UPGRADING 实例正在升级。
INITIALIZING 正在创建此实例。
SUSPENDING 实例正在暂停。
SUSPENDED 实例已暂停。
ORPHANED 实例没有虚拟机。升级移除了原始磁盘，但无法创建替代磁盘；数据磁盘和所有快照均完好无损。重试升级以完成升级，或将实例回滚到升级开始前截取的快照。

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 或代理访问权限），则会遭到拒绝并返回 INVALID_ARGUMENT。
request_id

string

可选。幂等请求 UUID。

UpgradeHistoryEntry

虚拟机映像升级历史记录的条目。

字段
snapshot

string

可选。相应笔记本实例在升级前的启动磁盘快照。
vm_image

string

可选。相应实例升级之前的虚拟机映像。
container_image

string

可选。相应实例升级之前的容器映像。
framework

string

可选。相应笔记本实例的框架。
version

string

可选。升级前的笔记本实例版本。
state

State

仅限输出。相应实例升级历史记录条目的状态。
create_time

Timestamp

不可变。相应实例升级历史记录条目的创建时间。
action

Action

可选。操作。回滚或升级。
target_version

string

可选。目标虚拟机版本，例如 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 虚拟机映像的定义，用于启动笔记本实例，并将环境直接安装在虚拟机上。

字段
project

string

必需。相应虚拟机映像所属的 Google Cloud 项目的名称。格式：{project_id}
image_description

string

仅限输出。实例上运行的映像的人类可读说明（例如“Debian 11，Python 3.10”），在读取时从映像发布配置（可靠来源）派生而来。对于无法识别的启动磁盘映像，请设置为“自定义”。
联合字段 image。对外部 Compute Engine 虚拟机映像的引用。image 只能是下列其中一项：
name

string

可选。使用虚拟机映像名称查找映像。
family

string

可选。使用此虚拟机映像系列查找映像；系统将使用此系列中的最新映像。