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,

  // Union field infrastructure can be only one of the following:
  "gceSetup": {
    object (GceSetup)
  }
  // End of list of possible types for union field infrastructure.
}
字段
name

string

仅限输出。标识符。相应笔记本实例的名称。格式:projects/{projectId}/locations/{location}/instances/{instanceId}

proxyUri

string

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

instanceOwners[]

string

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

目前仅支持一位所有者。如果未指定,则虚拟机实例的服务账号的所有服务账号用户都可以使用该实例。

creator

string

仅限输出。发送原始 instances.create 请求的实体的电子邮件地址。

state

enum (State)

仅限输出。相应实例的状态。

upgradeHistory[]

object (UpgradeHistoryEntry)

仅限输出。相应实例的升级历史记录。

id

string

仅限输出。资源的唯一 ID。

healthState

enum (HealthState)

仅限输出。实例 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 规范化(即转换为 UTC 零时区格式并在末尾附加 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 规范化(即转换为 UTC 零时区格式并在末尾附加 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,笔记本实例将不会向代理注册。

labels

map (key: string, value: string)

可选。要应用于相应实例的标签。这些设置稍后可通过 instances.patch 方法进行修改。

包含一系列 "key": value 对的对象。示例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }

thirdPartyProxyUrl

string

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

satisfiesPzs

boolean

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

satisfiesPzi

boolean

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

enableThirdPartyIdentity

boolean

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

enableManagedEuc

boolean

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

enableDeletionProtection

boolean

可选。如果为 true,则会为此工作台实例启用防删除保护。如果为 false,则将为此 Workbench 实例停用防删除保护。

联合字段 infrastructure。笔记本实例的设置。infrastructure 只能是下列其中一项:
gceSetup

object (GceSetup)

可选。笔记本的 Compute Engine 设置。使用笔记本定义的字段。

GceSetup

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

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,
    ...
  },
  "enableIpForwarding": boolean,
  "gpuDriverConfig": {
    object (GPUDriverConfig)
  },
  "confidentialInstanceConfig": {
    object (ConfidentialInstanceConfig)
  },
  "instanceId": string,

  // Union field image can be only one of the following:
  "vmImage": {
    object (VmImage)
  },
  "containerImage": {
    object (ContainerImage)
  }
  // End of list of possible types for union field image.
}
字段
machineType

string

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

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

bootDisk

object (BootDisk)

可选。虚拟机的启动磁盘。

dataDisks[]

object (DataDisk)

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

shieldedInstanceConfig

object (ShieldedInstanceConfig)

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

networkInterfaces[]

object (NetworkInterface)

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

disablePublicIp

boolean

可选。如果为 true,则不会为此虚拟机实例分配任何外部 IP。

tags[]

string

可选。要添加到运行时的 Compute Engine 网络标记(请参阅添加网络标记)。

metadata

map (key: string, value: string)

可选。要应用于相应实例的自定义元数据。

包含一系列 "key": value 对的对象。示例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }

enableIpForwarding

boolean

可选。用于启用或停用 IP 转发的标志,默认值为 false/停用。https://cloud.google.com/vpc/docs/using-routes#canipforward

gpuDriverConfig

object (GPUDriverConfig)

可选。GPU 驱动程序的配置。

confidentialInstanceConfig

object (ConfidentialInstanceConfig)

可选。保密实例配置。

instanceId

string

仅限输出。Compute Engine 实例资源的唯一 ID。

联合字段 image。映像的类型;可以是虚拟机映像,也可以是容器映像。image 只能是下列其中一项:
vmImage

object (VmImage)

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

containerImage

object (ContainerImage)

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

AcceleratorConfig

虚拟机实例的加速器配置硬件加速器的定义。请注意,系统不会检查 typecoreCount 的组合。不支持 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 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_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 P100 虚拟工作站。
NVIDIA_TESLA_P4_VWS 加速器类型为 NVIDIA Tesla P4 虚拟工作站。
NVIDIA_B200 加速器类型为 NVIDIA B200。

ServiceAccount

充当身份的服务账号。

JSON 表示法
{
  "email": string,
  "scopes": [
    string
  ]
}
字段
email

string

可选。服务账号的电子邮件地址。

scopes[]

string

仅限输出。要为此服务账号提供的范围列表。由 CLH 设置为 https://www.googleapis.com/auth/cloud-platform

VmImage

自定义 Compute Engine 虚拟机映像的定义,用于启动环境直接安装在虚拟机上的笔记本实例。

JSON 表示法
{
  "project": string,

  // Union field image can be only one of the following:
  "name": string,
  "family": string
  // End of list of possible types for union field image.
}
字段
project

string

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

联合字段 image。对外部 Compute Engine 虚拟机映像的引用。image 只能是下列其中一项:
name

string

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

family

string

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

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)

可选。附加到相应虚拟机实例的磁盘的大小(以 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

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

JSON 表示法
{
  "enableSecureBoot": boolean,
  "enableVtpm": boolean,
  "enableIntegrityMonitoring": boolean
}
字段
enableSecureBoot

boolean

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

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

enableVtpm

boolean

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

enableIntegrityMonitoring

boolean

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

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

NetworkInterface

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

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

string

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

subnet

string

可选。相应虚拟机实例所在的子网的名称。格式:projects/{projectId}/regions/{region}/subnetworks/{subnetwork_id}

nicType

enum (NicType)

可选。此接口上要使用的 vNIC 类型。可以是 gVNIC 或 VirtioNet。

accessConfigs[]

object (AccessConfig)

可选。相应接口的配置数组。目前,仅支持一种访问配置,即 ONE_TO_ONE_NAT。如果未指定 accessConfigs,实例将通过临时外部 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 在此虚拟机实例上安装 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 控制逻辑是安装所需框架并将实例注册到笔记本代理
ACTIVE 实例正在运行。
STOPPING 控制逻辑正在停止实例。
STOPPED 实例已停止。
DELETED 实例已删除。
UPGRADING 实例正在升级。
INITIALIZING 正在创建此实例。
SUSPENDING 实例正在暂停。
SUSPENDED 实例已暂停。

UpgradeHistoryEntry

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

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

可选。此实例升级之前的虚拟机映像。

containerImage

string

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

framework

string

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

version

string

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

state

enum (State)

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

createTime

string (Timestamp format)

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

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 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

可选。目标虚拟机版本,例如 m63。

相应升级历史记录条目的状态定义。

枚举
STATE_UNSPECIFIED 未指定状态。
STARTED 已开始升级实例。
SUCCEEDED 实例升级成功。
FAILED 实例升级失败。

操作

相应升级历史记录条目的操作定义。

枚举
ACTION_UNSPECIFIED 未指定操作。
UPGRADE 进行升级。
ROLLBACK 回滚。

HealthState

实例的运行状况。

枚举
HEALTH_STATE_UNSPECIFIED 实例子状态未知。
HEALTHY 已知实例处于健康状态(例如,关键守护程序正在运行)。适用于 ACTIVE 状态。
UNHEALTHY 已知实例处于不健康状态(例如,关键守护程序未运行)。适用于 ACTIVE 状态。
AGENT_NOT_INSTALLED 实例未安装健康监控代理。适用于 ACTIVE 状态。
AGENT_NOT_RUNNING 实例健康状况监控代理未运行。适用于 ACTIVE 状态。

方法

checkUpgradability

检查笔记本实例是否可升级。

create

在给定的项目和位置中创建一个新实例。

delete

删除单个实例。

diagnose

根据给定的实例创建诊断文件并运行诊断工具。

get

获取单个实例的详细信息。

getConfig

返回各种配置参数。

getIamPolicy

获取资源的访问权限控制政策。

list

列出给定项目和位置中的实例。

patch

UpdateInstance 会更新实例。

reset

重置笔记本实例。

resizeDisk

将笔记本实例磁盘调整为更高的容量。

restore

RestoreInstance 可从 BackupSource 恢复实例。

rollback

将笔记本实例回滚到先前版本。

setIamPolicy

针对指定资源设置访问权限控制政策。

start

启动笔记本实例。

stop

停止笔记本实例。

testIamPermissions

返回调用者对指定资源拥有的权限。

upgrade

将笔记本实例升级到最新版本。