资源:运行时
托管式笔记本实例的运行时的定义。
| JSON 表示法 |
|---|
{ "name": string, "state": enum ( |
| 字段 | |
|---|---|
name |
仅限输出。运行时的资源名称。格式: |
state |
仅限输出。运行时状态。 |
healthState |
仅限输出。运行时 healthState。 |
accessConfig |
用于访问运行时的配置设置。 |
softwareConfig |
运行时中软件的配置设置。 |
metrics |
仅限输出。包含运行时守护程序指标,例如服务状态和 JupyterLab 统计信息。 |
createTime |
仅限输出。运行时创建时间。 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例: |
updateTime |
仅限输出。运行时更新时间。 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例: |
labels |
可选。要与此受管笔记本或运行时相关联的标签。标签键必须包含 1 到 63 个字符,并且必须符合 RFC 1035 的要求。标签值可以为空,但如果存在,则必须包含 1 到 63 个字符,并且必须符合 RFC 1035。与集群关联的标签不得超过 32 个。 包含一系列 |
runtimeMigrationEligibility |
仅限输出。检查从 GmN 到 WbI 的迁移可行性。 |
联合字段 runtime_type。运行时类型;目前仅支持 Compute Engine 虚拟机。runtime_type 只能是下列其中一项: |
|
virtualMachine |
使用 Compute Engine 虚拟机映像启动受管笔记本实例。 |
migrated |
仅限输出。一个布尔值,用于指示相应笔记本是否已迁移到 Workbench 实例 |
VirtualMachine
使用虚拟机进行计算的运行时。
| JSON 表示法 |
|---|
{
"instanceName": string,
"instanceId": string,
"virtualMachineConfig": {
object ( |
| 字段 | |
|---|---|
instanceName |
仅限输出。受管 Compute Engine 实例的用户友好名称。 |
instanceId |
仅限输出。受管 Compute Engine 实例的唯一标识符。 |
virtualMachineConfig |
虚拟机配置设置。 |
VirtualMachineConfig
虚拟机的配置设置。
| JSON 表示法 |
|---|
{ "zone": string, "machineType": string, "containerImages": [ { object ( |
| 字段 | |
|---|---|
zone |
仅限输出。虚拟机所在的可用区。如果使用区域性请求,笔记本服务将选择相应运行时区域中的某个位置。在 GET 请求中,始终会存在可用区。示例:* |
machineType |
必需。运行时使用的 Compute Engine 机器类型。简称有效。示例:* |
containerImages[] |
可选。使用容器映像列表作为笔记本实例中的内核。 |
dataDisk |
必需。数据磁盘选项配置设置。 |
encryptionConfig |
可选。虚拟机数据磁盘的加密设置。 |
shieldedInstanceConfig |
可选。安全强化型虚拟机实例配置设置。 |
acceleratorConfig |
可选。相应运行时的 Compute Engine 加速器配置。 |
network |
可选。用于机器通信的 Compute Engine 网络。无法与子网一起指定。如果未指定 完整网址或部分 URI。示例:
运行时是 Google 基础架构中的受管理资源。运行时支持以下网络配置:
|
subnet |
可选。用于机器通信的 Compute Engine 子网。不能与网络一起指定。 完整网址或部分 URI 均有效。示例:
|
internalIpOnly |
可选。如果为 true,则运行时将仅具有内部 IP 地址。默认情况下,运行时不受限于内部 IP 地址,并且会为每个虚拟机分配临时外部 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 范围名称已用于 VPC 对等互连。如果分配了子网,则子网分配将使用范围 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。如需了解 SCSI over NVMe 的性能特征,请参阅“本地 SSD 性能”。有效值:
|
kind |
仅限输出。资源的类型。始终为挂接的磁盘计算 attachedDisk。 |
licenses[] |
仅限输出。任何有效的公开显示许可。 |
mode |
用于挂接相应磁盘的模式,可以是
|
source |
指定现有 Persistent Disk 资源的有效部分或完整网址。 |
type |
指定磁盘的类型,即
|
RuntimeGuestOsFeature
可选。要在客机操作系统上启用的一系列功能。仅适用于可启动的映像。请参阅启用客机操作系统功能,查看可用选项的列表。启动磁盘的客机操作系统功能。
| 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 资源标识符。其格式如下: |
RuntimeShieldedInstanceConfig
一组安全强化型实例选项。请参阅使用支持的安全强化型虚拟机功能的映像。并非所有组合都有效。
| 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 |
计算层正在安装所需框架,并向笔记本代理注册运行时。无法使用。 |
ACTIVE |
运行时目前正在运行,已准备就绪,可供使用。 |
STOPPING |
控制逻辑正在停止运行时。无法使用。 |
STOPPED |
运行时已停止,无法使用。 |
DELETING |
正在删除运行时。无法使用。 |
UPGRADING |
运行时正在升级,无法使用。 |
INITIALIZING |
正在创建和设置运行时。运行时尚未准备就绪,无法使用。 |
HealthState
运行时子状态。
| 枚举 | |
|---|---|
HEALTH_STATE_UNSPECIFIED |
运行时子状态未知。 |
HEALTHY |
已知运行时处于健康状态(例如,关键守护程序正在运行)。适用于 ACTIVE 状态。 |
UNHEALTHY |
已知运行时处于不健康状态(例如,关键守护程序未运行)。适用于 ACTIVE 状态。 |
AGENT_NOT_INSTALLED |
运行时未安装健康状况监控代理。适用于 ACTIVE 状态。 |
AGENT_NOT_RUNNING |
运行时健康状况监控代理未运行。适用于 ACTIVE 状态。 |
RuntimeAccessConfig
指定运行时的登录配置
| JSON 表示法 |
|---|
{
"accessType": enum ( |
| 字段 | |
|---|---|
accessType |
相应实例的访问模式类型。 |
runtimeOwner |
创建后相应运行时的所有者。格式: |
proxyUri |
仅限输出。用于访问运行时的代理端点。 |
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 |
采用世界协调时间 (UTC) 时区的 Cron 表达式,用于安排实例自动升级。请遵循 cron 格式。 |
idleShutdownTimeout |
在关闭运行时之前等待的时间(以分钟为单位)。默认值:180 分钟 |
installGpuDriver |
自动安装 Nvidia 驱动程序。默认值:True |
customGpuDriverPath |
指定存储 GPU 驱动程序的自定义 Cloud Storage 路径。如果未指定,我们将自动从官方 GPU 驱动程序中选择。 |
postStartupScript |
在笔记本实例完全启动后自动运行的 Bash 脚本的路径。该路径必须是网址或 Cloud Storage 路径 ( |
kernels[] |
可选。使用容器映像列表作为笔记本实例中的内核。 |
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
包含运行时守护程序指标,例如操作系统和内核以及会话统计信息。
| 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 选项。 |
错误
迁移错误消息表示,某些配置会导致 GmN 不符合自动迁移的条件。需要手动迁移。
| 枚举 | |
|---|---|
ERROR_UNSPECIFIED |
默认类型。 |
CUSTOM_CONTAINER |
GMN 配置了自定义容器,无法迁移。 |
方法 |
|
|---|---|
|
在给定的项目和位置中创建新的运行时。 |
|
删除单个运行时。 |
|
获取单个运行时的详细信息。 |
|
获取资源的访问权限控制政策。 |
|
列出给定项目和位置中的运行时。 |
|
将现有运行时迁移到新的 Workbench 实例。 |
|
更新了笔记本运行时配置。 |
|
报告并处理运行时事件。 |
|
重置托管式笔记本运行时。 |
|
针对指定资源设置访问权限控制政策。 |
|
启动代管式笔记本运行时。 |
|
停止代管式笔记本运行时。 |
|
切换托管式笔记本运行时。 |
|
返回调用者对指定资源拥有的权限。 |