Package google.cloud.notebooks.v1

索引

ManagedNotebookService

适用于受管笔记本的 API v1 服务。

CreateRuntime

rpc CreateRuntime(CreateRuntimeRequest) returns (Operation)

在给定的项目和位置中创建新的运行时。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
DeleteRuntime

rpc DeleteRuntime(DeleteRuntimeRequest) returns (Operation)

删除单个运行时。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
GetRuntime

rpc GetRuntime(GetRuntimeRequest) returns (Runtime)

获取单个运行时的详细信息。位置必须是区域端点，而不是可用区端点。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
ListRuntimes

rpc ListRuntimes(ListRuntimesRequest) returns (ListRuntimesResponse)

列出给定项目和位置中的运行时。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
MigrateRuntime

rpc MigrateRuntime(MigrateRuntimeRequest) returns (Operation)

将现有运行时迁移到新的 Workbench 实例。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
ReportRuntimeEvent

rpc ReportRuntimeEvent(ReportRuntimeEventRequest) returns (Operation)

报告并处理运行时事件。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
ResetRuntime

rpc ResetRuntime(ResetRuntimeRequest) returns (Operation)

重置托管式笔记本运行时。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
StartRuntime

rpc StartRuntime(StartRuntimeRequest) returns (Operation)

启动受管笔记本运行时。对 GPU 实例执行“启动”操作；对 CPU 实例执行“恢复”操作。请参阅：https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
StopRuntime

rpc StopRuntime(StopRuntimeRequest) returns (Operation)

停止受管笔记本运行时。对 GPU 实例执行“停止”操作；对 CPU 实例执行“暂停”操作。请参阅：https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
SwitchRuntime

rpc SwitchRuntime(SwitchRuntimeRequest) returns (Operation)

切换托管式笔记本运行时。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
UpdateRuntime

rpc UpdateRuntime(UpdateRuntimeRequest) returns (Operation)

更新了笔记本运行时配置。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。

NotebookService

适用于 Cloud AI Platform Notebooks 的 API v1 服务。

CreateEnvironment

rpc CreateEnvironment(CreateEnvironmentRequest) returns (Operation)

创建新环境。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
CreateExecution

rpc CreateExecution(CreateExecutionRequest) returns (Operation)

在给定的项目和位置中创建新的执行。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
CreateInstance

rpc CreateInstance(CreateInstanceRequest) returns (Operation)

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

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
CreateSchedule

rpc CreateSchedule(CreateScheduleRequest) returns (Operation)

在给定的项目和位置中创建新的已安排的笔记本。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
DeleteEnvironment

rpc DeleteEnvironment(DeleteEnvironmentRequest) returns (Operation)

删除单个环境。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
DeleteExecution

rpc DeleteExecution(DeleteExecutionRequest) returns (Operation)

删除执行

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
DeleteInstance

rpc DeleteInstance(DeleteInstanceRequest) returns (Operation)

删除单个实例。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
DeleteSchedule

rpc DeleteSchedule(DeleteScheduleRequest) returns (Operation)

删除时间表和所有底层作业

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
DiagnoseInstance

rpc DiagnoseInstance(DiagnoseInstanceRequest) returns (Operation)

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

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
GetEnvironment

rpc GetEnvironment(GetEnvironmentRequest) returns (Environment)

获取单个环境的详细信息。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
GetExecution

rpc GetExecution(GetExecutionRequest) returns (Execution)

获取执行的详细信息

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
GetInstance

rpc GetInstance(GetInstanceRequest) returns (Instance)

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

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
GetInstanceHealth

rpc GetInstanceHealth(GetInstanceHealthRequest) returns (GetInstanceHealthResponse)

检查笔记本实例的运行状况是否良好。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
GetSchedule

rpc GetSchedule(GetScheduleRequest) returns (Schedule)

获取时间表的详细信息

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
IsInstanceUpgradeable

rpc IsInstanceUpgradeable(IsInstanceUpgradeableRequest) returns (IsInstanceUpgradeableResponse)

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

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
ListEnvironments

rpc ListEnvironments(ListEnvironmentsRequest) returns (ListEnvironmentsResponse)

列出项目中的环境。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
ListExecutions

rpc ListExecutions(ListExecutionsRequest) returns (ListExecutionsResponse)

列出给定项目和位置中的执行

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
ListInstances

rpc ListInstances(ListInstancesRequest) returns (ListInstancesResponse)

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

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
ListSchedules

rpc ListSchedules(ListSchedulesRequest) returns (ListSchedulesResponse)

列出给定项目和位置中的时间表。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
MigrateInstance

rpc MigrateInstance(MigrateInstanceRequest) returns (Operation)

将现有的用户管理的笔记本迁移到 Workbench 实例。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
RegisterInstance

rpc RegisterInstance(RegisterInstanceRequest) returns (Operation)

向 Notebooks API 服务器注册现有的旧版笔记本实例。旧版实例是指使用旧版 Compute Engine 调用创建的实例。这些实例无法通过 Notebooks API 直接管理。此调用可使这些实例能够通过 Notebooks API 进行管理。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
ReportInstanceInfo

rpc ReportInstanceInfo(ReportInstanceInfoRequest) returns (Operation)

允许笔记本实例向 Notebooks API 服务器报告其最新的实例信息。服务器会将报告的信息合并到实例元数据存储空间。请勿直接使用此方法。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
ResetInstance

rpc ResetInstance(ResetInstanceRequest) returns (Operation)

重置笔记本实例。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
RollbackInstance

rpc RollbackInstance(RollbackInstanceRequest) returns (Operation)

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

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
SetInstanceAccelerator

rpc SetInstanceAccelerator(SetInstanceAcceleratorRequest) returns (Operation)

更新单个实例的 guest 加速器。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
SetInstanceLabels

rpc SetInstanceLabels(SetInstanceLabelsRequest) returns (Operation)

替换实例的所有标签。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
SetInstanceMachineType

rpc SetInstanceMachineType(SetInstanceMachineTypeRequest) returns (Operation)

更新单个实例的机器类型。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
StartInstance

rpc StartInstance(StartInstanceRequest) returns (Operation)

启动笔记本实例。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
StopInstance

rpc StopInstance(StopInstanceRequest) returns (Operation)

停止笔记本实例。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
UpdateInstanceConfig

rpc UpdateInstanceConfig(UpdateInstanceConfigRequest) returns (Operation)

更新了笔记本实例配置。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
UpdateInstanceMetadataItems

rpc UpdateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest) returns (UpdateInstanceMetadataItemsResponse)

为实例添加/更新元数据项。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
UpdateShieldedInstanceConfig

rpc UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest) returns (Operation)

更新单个实例的受防护的实例配置。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。
UpgradeInstance

rpc UpgradeInstance(UpgradeInstanceRequest) returns (Operation)

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

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。

ContainerImage

用于启动笔记本实例的容器映像的定义，其中包含已安装在容器中的环境。

字段
repository

string

必需。容器映像代码库的路径。例如：gcr.io/{project_id}/{image_name}
tag

string

容器映像的标记。如果未指定，则默认为最新标记。

CreateEnvironmentRequest

用于创建笔记本环境的请求。

字段
parent

string

必需。格式：projects/{project_id}/locations/{location}

必须对指定的资源 parent 具有以下 IAM 权限才能进行授权：

  • notebooks.environments.create
environment_id

string

必需。相应环境的用户定义唯一 ID。environment_id 的长度必须介于 1 到 63 个字符之间，并且只能包含小写字母、数字字符和短划线。第一个字符必须是小写字母，最后一个字符不能是短划线。
environment

Environment

必需。要创建的环境。

CreateExecutionRequest

创建笔记本执行的请求

字段
parent

string

必需。格式：parent=projects/{project_id}/locations/{location}

必须对指定的资源 parent 具有以下 IAM 权限才能进行授权：

  • notebooks.executions.create
execution_id

string

必需。相应执行的用户定义的唯一 ID。
execution

Execution

必需。要创建的执行。

CreateInstanceRequest

用于创建笔记本实例的请求。

字段
parent

string

必需。格式：parent=projects/{project_id}/locations/{location}

必须对指定的资源 parent 具有以下 IAM 权限才能进行授权：

  • notebooks.instances.create
instance_id

string

必需。相应实例的用户定义的唯一 ID。
instance

Instance

必需。要创建的实例。

CreateRuntimeRequest

用于创建托管式笔记本运行时的请求。

字段
parent

string

必需。格式：parent=projects/{project_id}/locations/{location}

必须对指定的资源 parent 具有以下 IAM 权限才能进行授权：

  • notebooks.runtimes.create
runtime_id

string

必需。相应运行时的用户定义唯一 ID。
runtime

Runtime

必需。要创建的运行时。
request_id

string

幂等请求 UUID。

CreateScheduleRequest

针对已创建的已安排笔记本的请求

字段
parent

string

必需。格式：parent=projects/{project_id}/locations/{location}

必须对指定的资源 parent 具有以下 IAM 权限才能进行授权：

  • notebooks.schedules.create
schedule_id

string

必需。相应安排的用户定义的唯一 ID。
schedule

Schedule

必需。要创建的时间表。

DeleteEnvironmentRequest

用于删除笔记本环境的请求。

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/environments/{environment_id}

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

  • notebooks.environments.delete

DeleteExecutionRequest

请求删除已安排的笔记本执行

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/executions/{execution_id}

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

  • notebooks.executions.delete

DeleteInstanceRequest

请求删除笔记本实例。

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/instances/{instance_id}

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

  • notebooks.instances.delete

DeleteRuntimeRequest

用于删除受管理的笔记本运行时的请求。

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/runtimes/{runtime_id}

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

  • notebooks.runtimes.delete
request_id

string

幂等请求 UUID。

DeleteScheduleRequest

请求删除 Schedule

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/schedules/{schedule_id}

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

  • notebooks.schedules.delete

DiagnoseInstanceRequest

用于创建笔记本实例诊断文件的请求。

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/instances/{instance_id}
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/
repair_flag_enabled

bool

可选。启用标志以修复实例的服务
packet_capture_flag_enabled

bool

可选。启用标志以从实例捕获数据包 30 秒
copy_home_files_flag_enabled

bool

可选。启用标志以复制所有 /home/jupyter 文件夹内容

EncryptionConfig

表示可应用于资源的自定义加密密钥配置。此配置将加密虚拟机中的所有磁盘。

字段
kms_key

string

用于保护资源（如磁盘）的客户管理的加密密钥的 Cloud KMS 资源标识符。其格式如下：projects/{PROJECT_ID}/locations/{REGION}/keyRings/{KEY_RING_NAME}/cryptoKeys/{KEY_NAME}

环境

用于启动笔记本实例的软件环境的定义。

字段
name

string

仅限输出。相应环境的名称。格式：projects/{project_id}/locations/{location}/environments/{environment_id}
display_name

string

相应环境在界面中的显示名称。
description

string

此环境的简要说明。
post_startup_script

string

在笔记本实例完全启动后自动运行的 Bash 脚本的路径。该路径必须是网址或 Cloud Storage 路径。示例："gs://path-to-file/file-name"
create_time

Timestamp

仅限输出。相应环境的创建时间。
联合字段 image_type。环境类型；可以是虚拟机映像，也可以是容器映像。image_type 只能是下列其中一项：
vm_image

VmImage

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

ContainerImage

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

事件

受管 / 半受管笔记本实例的事件定义。

字段
report_time

Timestamp

事件报告时间。
type

EventType

活动类型。
details

map<string, string>

可选。活动详情。此字段用于传递事件信息。

EventType

事件类型的定义。

枚举
EVENT_TYPE_UNSPECIFIED 未指定活动。
IDLE 实例 / 运行时处于空闲状态
HEARTBEAT 实例 / 运行时可用。此事件表示实例 / 运行时底层计算资源可正常运行。
HEALTH 实例 / 运行时健康状况可用。此事件表示实例 / 运行时健康状况信息。
MAINTENANCE 实例 / 运行时可用。此事件允许实例 / 运行时将主机维护信息发送到控制层面。https://cloud.google.com/compute/docs/gpus/gpu-host-maintenance

执行

单个已执行笔记本的定义。

字段
execution_template

ExecutionTemplate

执行元数据，包括名称、硬件规格、区域、标签等。
name

string

仅限输出。执行的资源名称。格式：projects/{project_id}/locations/{location}/executions/{execution_id}
display_name

string

仅限输出。用于界面目的的名称。名称只能包含字母数字字符和下划线“_”。
description

string

相应执行的简要说明。
create_time

Timestamp

仅限输出。执行的实例化时间。
update_time

Timestamp

仅限输出。上次更新执行的时间。
state

State

仅限输出。底层 AI Platform 作业的状态。
output_notebook_file

string

相应执行生成的输出笔记本文件
job_uri

string

仅限输出。用于执行笔记本的外部作业的 URI。

州

底层 AIP 作业的状态的枚举说明。

枚举
STATE_UNSPECIFIED 未指定作业状态。
QUEUED 作业刚刚创建完毕，尚未开始处理。
PREPARING 服务正在准备执行作业。
RUNNING 作业正在处理中。
SUCCEEDED 作业已成功完成。
FAILED 作业失败。error_message 应包含失败详细信息。
CANCELLING 正在取消作业。error_message 应描述取消的原因。
CANCELLED 作业已取消。error_message 应描述取消的原因。
EXPIRED 作业已过期（与 Agent Platform 作业相关）https://cloud.google.com/gemini-enterprise-agent-platform/reference/rest/v1/JobState
INITIALIZING 正在创建执行。

ExecutionTemplate

笔记本执行工作负载的说明。

字段
scale_tier
(deprecated)

ScaleTier

必需。用于执行笔记本的硬件的规模层级。已弃用，即将停用。因为目前仅支持 CUSTOM。
master_type

string

指定用于训练作业的主工作器的虚拟机类型。如果 scaleTier 设置为 CUSTOM，您必须指定此字段。

您可以直接在此字段中使用特定的 Compute Engine 机器类型。系统支持以下类型：

  • 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 进行训练的特殊配置选项。
accelerator_config

SchedulerAcceleratorConfig

运行笔记本执行的硬件的配置（数量和加速器类型）。
labels

map<string, string>

执行的标签。如果执行是已安排的，则会包含“nbs-scheduled”字段。否则，执行是立即执行，并且会包含“nbs-immediate”字段。使用这些字段可以高效地在各种类型的执行之间进行索引。
input_notebook_file

string

要执行的笔记本文件的路径。必须位于 Google Cloud Storage 存储桶中。格式：gs://{bucket_name}/{folder}/{notebook_file_name} 示例：gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb
container_image_uri

string

DLVM 的容器映像 URI 示例：'gcr.io/deeplearning-platform-release/base-cu100' 您可以在以下网址找到更多示例：https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container
output_notebook_folder

string

要写入的笔记本文件夹的路径。必须采用 Google Cloud Storage 存储桶路径格式。格式：gs://{bucket_name}/{folder} 示例：gs://notebook_user/scheduled_notebooks
params_yaml_file

string

在笔记本执行期间要替换的参数。如需了解如何在输入笔记本中指定参数，并在此处以 YAML 文件形式传递这些参数，请参阅 https://papermill.readthedocs.io/en/latest/usage-parameterize.html。例如：gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml
parameters

string

在“input_notebook_file”笔记本中使用的参数。
service_account

string

运行执行时要使用的服务账号的电子邮件地址。您必须拥有指定服务账号的 iam.serviceAccounts.actAs 权限。
job_type

JobType

相应执行中要使用的作业类型。
kernel_spec

string

要使用的内核规范的名称。如果执行目标上的内核规范名称与输入笔记本文件中的名称不匹配，则必须指定此参数。
tensorboard

string

相应执行将向其上传 Tensorboard 日志的 Agent Platform [Tensorboard] 资源的名称。格式：projects/{project}/locations/{location}/tensorboards/{tensorboard}
联合字段 job_parameters。执行类型的参数。注意：目前，VertexAI 作业没有额外的参数。job_parameters 只能是下列其中一项：
dataproc_parameters

DataprocParameters

在 Dataproc JobType 执行中使用的参数。
vertex_ai_parameters

VertexAIParameters

在 Agent Platform JobType 执行中使用的参数。

DataprocParameters

在 Dataproc JobType 执行中使用的参数。

字段
cluster

string

用于运行 Dataproc 执行的集群的 URI。格式：projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}

JobType

相应执行所使用的后端。

枚举
JOB_TYPE_UNSPECIFIED 未指定类型。
VERTEX_AI aiplatform.googleapis.com 中的自定义作业。执行的默认值。
DATAPROC 以作业形式在具有 Dataproc 的集群上运行执行。https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs

ScaleTier

必需。指定机器类型、工作器和参数服务器的副本数。

枚举
SCALE_TIER_UNSPECIFIED 未指定规模层级。
BASIC 单一工作器实例。该层级适合用于学习如何使用 Cloud ML 以及如何使用小数据集来试验新模型。
STANDARD_1 许多工作器和一些参数服务器。
PREMIUM_1 大量工作器和许多参数服务器。
BASIC_GPU 带有一个 K80 GPU 的单一工作器实例。
BASIC_TPU 带有 Cloud TPU 的单个工作器实例。
CUSTOM

CUSTOM 层级不是预设层级，但允许您使用自定义集群规范。使用该层级时，请根据以下准则设置值，以配置处理集群：

  • 您必须设置 ExecutionTemplate.masterType 以指定主节点使用的机器类型。这是唯一的必需设置。

SchedulerAcceleratorConfig

硬件加速器的定义。请注意，并非所有 type 和 core_count 的组合都是有效的。如需查找有效组合，请参阅 Compute Engine 上的 GPU。不支持 TPU。

字段
type

SchedulerAcceleratorType

相应加速器的类型。
core_count

int64

相应加速器的核心数。

SchedulerAcceleratorType

AI Platform Training 作业的硬件加速器类型。

枚举
SCHEDULER_ACCELERATOR_TYPE_UNSPECIFIED 未指定的加速器类型。默认为不带 GPU。
NVIDIA_TESLA_K80 Nvidia Tesla K80 GPU。
NVIDIA_TESLA_P100 Nvidia Tesla P100 GPU。
NVIDIA_TESLA_V100 Nvidia Tesla V100 GPU。
NVIDIA_TESLA_P4 Nvidia Tesla P4 GPU。
NVIDIA_TESLA_T4 Nvidia Tesla T4 GPU。
NVIDIA_TESLA_A100 Nvidia Tesla A100 GPU。
TPU_V2 TPU v2。
TPU_V3 TPU v3。

VertexAIParameters

在 Agent Platform JobType 执行中使用的参数。

字段
network

string

作业应与之对等互连的 Compute Engine 网络的全名。例如 projects/12345/global/networks/myVPC。格式为 projects/{project}/global/networks/{network}。其中，{project} 是项目编号，如 12345 中所示，{network} 是网络名称。

该网络必须已配置专用服务访问通道。如果未指定，则作业不与任何网络对等互连。
env

map<string, string>

环境变量。最多可以指定 100 个环境变量，且这些变量必须是唯一的。示例：GCP_BUCKET=gs://my-bucket/samples/

GetEnvironmentRequest

用于获取笔记本环境的请求。

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/environments/{environment_id}

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

  • notebooks.environments.get

GetExecutionRequest

请求获取已安排的笔记本执行

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/executions/{execution_id}

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

  • notebooks.executions.get

GetInstanceHealthRequest

用于检查笔记本实例是否运行正常的请求。

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/instances/{instance_id}

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

  • notebooks.instances.getHealth

GetInstanceHealthResponse

用于检查笔记本实例是否正常的响应。

字段
health_state

HealthState

仅限输出。运行时 health_state。
health_info

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

HealthState

实例是否健康。

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

GetInstanceRequest

用于获取笔记本实例的请求。

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/instances/{instance_id}

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

  • notebooks.instances.get

GetRuntimeRequest

用于获取受管理的笔记本运行时的请求。

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/runtimes/{runtime_id}

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

  • notebooks.runtimes.get

GetScheduleRequest

请求获取已安排的笔记本。

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/schedules/{schedule_id}

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

  • notebooks.schedules.get

实例

笔记本实例的定义。

字段
name

string

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

string

在笔记本实例完全启动后自动运行的 Bash 脚本的路径。该路径必须是网址或 Cloud Storage 路径 (gs://path-to-file/file-name)。
proxy_uri

string

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

string

仅限输入。创建后相应实例的所有者。格式：alias@example.com

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

string

此实例上的服务账号，用于授予对其他 Google Cloud 服务的访问权限。您可以使用同一项目中的任意服务账号，但您必须拥有服务账号用户权限才能使用实例。

如果未指定，则使用 Compute Engine 默认服务账号。
service_account_scopes[]

string

可选。要包含在 Compute Engine 实例中的服务账号范围的 URI。

如果未指定，则定义以下范围：- https://www.googleapis.com/auth/cloud-platform- https://www.googleapis.com/auth/userinfo.email如果不使用默认范围，则至少需要：https://www.googleapis.com/auth/compute
machine_type

string

必需。相应实例的 Compute Engine 机器类型。
accelerator_config

AcceleratorConfig

相应实例上使用的硬件加速器。如果您使用加速器，请确保您的配置具有足够的 vCPU 和内存来支持您选择的 machine_type。
state

State

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

bool

最终用户是否授权 Google Cloud 在此实例上安装 GPU 驱动程序。如果此字段为空或设置为 false，则不会安装 GPU 驱动程序。仅适用于具有 GPU 的实例。
custom_gpu_driver_path

string

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

DiskType

仅限输入。附加到此实例的启动磁盘的类型，默认为标准永久性磁盘 (PD_STANDARD)。
boot_disk_size_gb

int64

仅限输入。附加到相应实例的启动磁盘的大小（以 GB 为单位），最大为 64000 GB (64 TB)。建议的最小值是 100 GB。如果未指定，则此值默认为 100。
data_disk_type

DiskType

仅限输入。附加到此实例的数据磁盘的类型，默认为标准永久性磁盘 (PD_STANDARD)。
data_disk_size_gb

int64

仅限输入。附加到此实例的数据磁盘的大小（以 GB 为单位），最大为 64000 GB (64 TB)。您可以根据笔记本和数据的大小选择数据磁盘的大小。如果未指定，则此值默认为 100。
no_remove_data_disk

bool

仅限输入。如果为 true，则在删除实例时不会自动删除数据磁盘。
disk_encryption

DiskEncryption

仅限输入。启动磁盘和数据磁盘上使用的磁盘加密方法，默认为 GMEK。
kms_key

string

仅限输入。用于加密磁盘的 KMS 密钥，仅当 disk_encryption 为 CMEK 时适用。格式：projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

详细了解如何使用自己的加密密钥。
disks[]

Disk

仅限输出。将磁盘挂接到笔记本实例。
shielded_instance_config

ShieldedInstanceConfig

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

bool

如果为 true，则不会为此实例分配任何外部 IP。
no_proxy_access

bool

如果值为 true，笔记本实例将不会向代理注册。
network

string

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

string

相应实例所在的子网的名称。格式：projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
labels

map<string, string>

要应用于相应实例的标签。这些标签稍后可通过 setLabels 方法进行修改。
metadata

map<string, string>

要应用于相应实例的自定义元数据。例如，如需指定用于自动备份的 Cloud Storage 存储桶，您可以使用 gcs-data-bucket 元数据标记。格式："--metadata=gcs-data-bucket=BUCKET"。
tags[]

string

可选。要添加到运行时的 Compute Engine 网络标记（请参阅添加网络标记）。
upgrade_history[]

UpgradeHistoryEntry

相应实例的升级历史记录。
nic_type

NicType

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

ReservationAffinity

可选。可选的预留亲和性。设置此字段会将指定的可用区级计算预留应用于此笔记本实例。
creator

string

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

bool

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

Timestamp

仅限输出。实例创建时间。
update_time

Timestamp

仅限输出。实例更新时间。
instance_migration_eligibility

InstanceMigrationEligibility

仅限输出。检查从 UmN 到 WbI 的迁移可行性。
联合字段 environment。环境类型；可以是虚拟机映像，也可以是容器映像。environment 只能是下列其中一项：
vm_image

VmImage

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

ContainerImage

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

bool

仅限输出。一个布尔值，用于指示相应笔记本是否已迁移到 Workbench 实例

AcceleratorConfig

硬件加速器的定义。请注意，并非所有 type 和 core_count 的组合都是有效的。如需查找有效组合，请参阅 Compute Engine 上的 GPU。不支持 TPU。

字段
type

AcceleratorType

相应加速器的类型。
core_count

int64

相应加速器的核心数。

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。
NVIDIA_L4 加速器类型为 Nvidia Tesla L4。
NVIDIA_A100_80GB 加速器类型为 Nvidia Tesla A100 80GB。
NVIDIA_TESLA_T4_VWS 加速器类型为 NVIDIA Tesla T4 虚拟工作站。
NVIDIA_TESLA_P100_VWS 加速器类型为 NVIDIA Tesla P100 虚拟工作站。
NVIDIA_TESLA_P4_VWS 加速器类型为 NVIDIA Tesla P4 虚拟工作站。
NVIDIA_H100_80GB 加速器类型为 NVIDIA H100 80GB。
NVIDIA_H100_MEGA_80GB 加速器类型为 NVIDIA H100 Mega 80GB。
TPU_V2 （敬请期待）加速器类型为 TPU V2。
TPU_V3 （敬请期待）加速器类型为 TPU V3。

磁盘

附加到实例的磁盘资源。

字段
auto_delete

bool

指示在删除实例时是否会自动删除磁盘（但从实例分离磁盘时不会自动删除）。
boot

bool

表示这是启动磁盘。虚拟机将使用磁盘的第一个分区作为其根文件系统。
device_name

string

表示您选择的唯一设备名称，该名称会反映到实例内运行的 Linux 操作系统的 /dev/disk/by-id/google-* 树中。您可以使用此名称在实例中引用要装载、调整大小等的设备。

如果未指定，服务器将选择要应用于此磁盘的默认设备名称，格式为 persistent-disk-x，其中 x 是 Google Compute Engine 分配的号码。此字段仅适用于永久性磁盘。
disk_size_gb

int64

以 2 为底的 GB 为单位表示磁盘的大小。
guest_os_features[]

GuestOsFeature

表示要在客机操作系统上启用的一系列功能。仅适用于可启动的映像。请参阅“启用客机操作系统功能”以查看可用选项的列表。
index

int64

相应磁盘的从零开始的索引，其中 0 保留给启动磁盘。如果您将多个磁盘挂接到一个实例，则每个磁盘都会有一个唯一的索引号。
interface

string

表示用于挂接相应磁盘的磁盘接口，可以是 SCSI 或 NVME。默认值为 SCSI。永久性磁盘必须始终使用 SCSI，如果您尝试以 SCSI 以外的任何其他格式附加永久性磁盘，请求都会失败。本地 SSD 可以使用 NVME 或 SCSI。如需了解 SCSI over NVMe 的性能特征，请参阅“本地 SSD 性能”。有效值：

  • NVME
  • SCSI
kind

string

资源的类型。对于已挂接的磁盘，始终为 compute#attachedDisk。
licenses[]

string

公开显示的许可列表。预留给 Google 使用。许可表示公开映像和 Marketplace 映像的结算和汇总使用情况数据。
mode

string

用于挂接相应磁盘的模式，可以是 READ_WRITE 或 READ_ONLY。如果未指定，则默认以 READ_WRITE 模式附加磁盘。有效值：

  • READ_ONLY
  • READ_WRITE
source

string

表示指向现有 Persistent Disk 资源的有效部分或完整网址。
type

string

表示磁盘的类型，即 SCRATCH 或 PERSISTENT。有效值：

  • PERSISTENT
  • SCRATCH

GuestOsFeature

启动磁盘的客机操作系统功能。

字段
type

string

受支持功能的 ID。请参阅“启用客机操作系统功能”，查看可用选项的列表。有效值：

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

DiskEncryption

磁盘加密选项的定义。

枚举
DISK_ENCRYPTION_UNSPECIFIED 未指定磁盘加密。
GMEK 使用 Google 管理的加密密钥对启动磁盘进行加密。
CMEK 使用客户管理的加密密钥来加密启动磁盘。

DiskType

笔记本实例的可能磁盘类型。

枚举
DISK_TYPE_UNSPECIFIED 未设置磁盘类型。
PD_STANDARD 标准永久性磁盘类型。
PD_SSD SSD 永久性磁盘类型。
PD_BALANCED 平衡永久性磁盘类型。
PD_EXTREME 至尊永久性磁盘类型。

NicType

vNIC 驱动程序的类型。默认值应为 UNSPECIFIED_NIC_TYPE。

枚举
UNSPECIFIED_NIC_TYPE 未指定类型。
VIRTIO_NET VIRTIO
GVNIC GVNIC

ShieldedInstanceConfig

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

字段
enable_secure_boot

bool

定义实例是否已启用安全启动。

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

bool

定义实例是否已启用 vTPM。默认处于启用状态。
enable_integrity_monitoring

bool

定义实例是否已启用完整性监控。

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

州

相应实例的状态定义。

枚举
STATE_UNSPECIFIED 未指定状态。
STARTING 控制逻辑正在启动实例。
PROVISIONING 控制逻辑是安装所需框架并将实例注册到笔记本代理
ACTIVE 实例正在运行。
STOPPING 控制逻辑正在停止实例。
STOPPED 实例已停止。
DELETED 实例已删除。
UPGRADING 实例正在升级。
INITIALIZING 正在创建此实例。
REGISTERING 实例正在注册。
SUSPENDING 实例正在暂停。
SUSPENDED 实例已暂停。

UpgradeHistoryEntry

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

字段
snapshot

string

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

string

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

string

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

string

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

string

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

State

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

Timestamp

相应实例升级历史记录条目的创建时间。
target_image
(deprecated)

string

目标虚拟机映像。格式：ainotebooks-vm/project/image-name/name。
action

Action

操作。回滚或升级。
target_version

string

目标虚拟机版本，例如 m63。

操作

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

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

州

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

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

InstanceConfig

可更新的笔记本实例配置。

字段
notebook_upgrade_schedule

string

采用世界协调时间 (UTC) 时区的 Cron 表达式，用于安排实例自动升级。请遵循 cron 格式。
enable_health_monitoring

bool

验证核心内部服务是否正在运行。

InstanceMigrationEligibility

InstanceMigrationEligibility 表示从 UmN 到 WbI 的迁移可行性信息。

字段
warnings[]

Warning

仅限输出。迁移期间，某些配置将采用默认设置。
errors[]

Error

仅限输出。某些配置会导致 UmN 不符合自动迁移的条件。需要手动迁移。

错误

迁移错误消息表示，某些配置会导致 UmN 不符合自动迁移的条件，因此需要手动迁移。

枚举
ERROR_UNSPECIFIED 默认类型。
DATAPROC_HUB UmN 使用 Dataproc Hub，无法迁移。

警告

迁移警告消息表示，在迁移期间，某些配置将采用默认设置。

枚举
WARNING_UNSPECIFIED 默认类型。
UNSUPPORTED_MACHINE_TYPE UmN 使用的机器类型在 WbI 中不受支持。它将使用默认机器类型 e2-standard-4 进行迁移。用户可以在迁移后更改机器类型。
UNSUPPORTED_ACCELERATOR_TYPE Umn 使用的加速器类型在 WbI 中不受支持。它将在没有加速器的情况下进行迁移。用户可以在迁移后连接加速器。
UNSUPPORTED_OS Umn 使用的操作系统在 WbI 中不受支持（例如 Debian 10、Ubuntu）。在 WbI 中，它将被 Debian 11 取代。
NO_REMOVE_DATA_DISK 此 UmN 配置了 no_remove_data_disk，但该设置在 WbI 中已不再可用。
GCS_BACKUP 此 UmN 配置了 Cloud Storage 备份功能，但该功能在 WbI 中不再可用。
POST_STARTUP_SCRIPT 此 UmN 配置了启动后脚本。请选择性地提供迁移的 post_startup_script_option。

IsInstanceUpgradeableRequest

用于检查笔记本实例是否可升级的请求。

字段
notebook_instance

string

必需。格式：projects/{project_id}/locations/{location}/instances/{instance_id}

必须对指定的资源 notebookInstance 具有以下 IAM 权限才能进行授权：

  • notebooks.instances.checkUpgradability
type

UpgradeType

可选。可选的 UpgradeType。设置此字段将搜索其他计算映像来升级此实例。

IsInstanceUpgradeableResponse

用于检查笔记本实例是否可升级的响应。

字段
upgradeable

bool

如果实例可以升级。
upgrade_version

string

如果调用升级端点，相应实例将升级到的版本。只有当 field_upgradeable 为 true 时，系统才会填充此字段。
upgrade_info

string

有关升级的其他信息。
upgrade_image

string

如果调用升级端点，相应实例将升级到的新映像的自链接。只有当 field_upgradeable 为 true 时，此字段才会填充。

ListEnvironmentsRequest

用于列出环境的请求。

字段
parent

string

必需。格式：projects/{project_id}/locations/{location}

必须对指定的资源 parent 具有以下 IAM 权限才能进行授权：

  • notebooks.environments.list
page_size

int32

列表调用的最大返回大小。
page_token

string

之前返回的页面令牌，可用于从上一个结果继续列出。

ListEnvironmentsResponse

列出环境的响应。

字段
environments[]

Environment

返回的环境列表。
next_page_token

string

一种页面令牌，可用于在下一次列表调用中从上一次结果继续列出。
unreachable[]

string

无法到达的位置。

ListExecutionsRequest

请求列出已安排的笔记本执行。

字段
parent

string

必需。格式：parent=projects/{project_id}/locations/{location}

必须对指定的资源 parent 具有以下 IAM 权限才能进行授权：

  • notebooks.executions.list
page_size

int32

列表调用的最大返回大小。
page_token

string

之前返回的页面令牌，可用于从上一个结果继续列出。
filter

string

应用于所得执行的过滤条件。目前仅支持按指定的 schedule_id 过滤执行。格式：schedule_id=<Schedule_ID>
order_by

string

按字段排序。

ListExecutionsResponse

列出已安排的笔记本执行的响应

字段
executions[]

Execution

返回的实例列表。
next_page_token

string

可用于在下一次列表调用中从上一次结果继续列出的页面令牌。
unreachable[]

string

无法到达的执行 ID。例如：

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

ListInstancesRequest

用于列出笔记本实例的请求。

字段
parent

string

必需。格式：parent=projects/{project_id}/locations/{location}

必须对指定的资源 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

无法到达的位置。例如 ['us-west1-a', 'us-central1-b']。ListInstancesResponse 将仅包含实例或无法访问的实例，

ListRuntimesRequest

请求列出受管理的笔记本运行时。

字段
parent

string

必需。格式：parent=projects/{project_id}/locations/{location}

必须对指定的资源 parent 具有以下 IAM 权限才能进行授权：

  • notebooks.runtimes.list
page_size

int32

列表调用的最大返回大小。
page_token

string

之前返回的页面令牌，可用于从上一个结果继续列出。
order_by

string

可选。对结果排序。受支持的值包括 "name"、"name desc" 或 ""（未排序）。
filter

string

可选。列出过滤条件。

ListRuntimesResponse

列出托管式笔记本运行时的响应。

字段
runtimes[]

Runtime

返回的运行时的列表。
next_page_token

string

可用于在下一次列表调用中从上一次结果继续列出的页面令牌。
unreachable[]

string

无法到达的位置。例如 ['us-west1', 'us-central1']。ListRuntimesResponse 将仅包含运行时或无法访问的运行时，

ListSchedulesRequest

请求列出已调度的笔记本作业。

字段
parent

string

必需。格式：parent=projects/{project_id}/locations/{location}

必须对指定的资源 parent 具有以下 IAM 权限才能进行授权：

  • notebooks.schedules.list
page_size

int32

列表调用的最大返回大小。
page_token

string

之前返回的页面令牌，可用于从上一个结果继续列出。
filter

string

应用于生成的日程的过滤条件。
order_by

string

用于对结果进行排序的字段。

ListSchedulesResponse

用于列出已调度的笔记本作业的响应。

字段
schedules[]

Schedule

返回的实例列表。
next_page_token

string

可用于在下一次列表调用中从上一次结果继续列出的页面令牌。
unreachable[]

string

无法到达的日程。例如：

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

LocalDisk

本地附加磁盘资源。

字段
auto_delete

bool

可选。仅限输出。指定在删除实例时是否自动删除磁盘（但从实例分离磁盘时不会自动删除）。
boot

bool

可选。仅限输出。表示这是启动磁盘。虚拟机将使用磁盘的第一个分区作为其根文件系统。
device_name

string

可选。仅限输出。指定您选择的唯一设备名称，该名称会反映到实例内运行的 Linux 操作系统的 /dev/disk/by-id/google-* 树中。此名称可用于在实例中引用要装载、调整大小等的设备。

如果未指定，服务器将选择要应用于此磁盘的默认设备名称，格式为 persistent-disk-x，其中 x 是 Google Compute Engine 分配的号码。此字段仅适用于永久性磁盘。
guest_os_features[]

RuntimeGuestOsFeature

仅限输出。表示要在客户机操作系统上启用的一系列功能。仅适用于可启动的映像。请参阅“启用客机操作系统功能”，查看可用选项的列表。
index

int32

仅限输出。此磁盘的从零开始的索引，其中 0 保留给启动磁盘。如果您将多个磁盘挂接到一个实例，则每个磁盘都会有一个唯一的索引号。
initialize_params

LocalDiskInitializeParams

仅限输入。指定将与新实例一起创建的新磁盘的参数。使用初始化参数创建挂接到新实例的启动磁盘或本地 SSD。

此属性与来源媒体资源互斥；您只能定义其中一个，而不能同时定义这两个属性。
interface

string

指定用于挂接相应磁盘的磁盘接口，可以是 SCSI 或 NVME。默认值为 SCSI。永久性磁盘必须始终使用 SCSI，如果您尝试以 SCSI 以外的任何其他格式附加永久性磁盘，请求都会失败。本地 SSD 可以使用 NVME 或 SCSI。如需了解 SCSI over NVMe 的性能特征，请参阅“本地 SSD 性能”。有效值：

  • NVME
  • SCSI
kind

string

仅限输出。资源的类型。始终为挂接的磁盘计算 attachedDisk。
licenses[]

string

仅限输出。任何有效的公开显示许可。
mode

string

用于挂接相应磁盘的模式，可以是 READ_WRITE 或 READ_ONLY。如果未指定，则默认以 READ_WRITE 模式附加磁盘。有效值：

  • READ_ONLY
  • READ_WRITE
source

string

指定现有 Persistent Disk 资源的有效部分或完整网址。
type

string

指定磁盘的类型，即 SCRATCH 或 PERSISTENT。如果未指定，则默认值为 PERSISTENT。有效值：

  • PERSISTENT
  • SCRATCH

RuntimeGuestOsFeature

可选。要在客机操作系统上启用的一系列功能。仅适用于可启动的映像。请参阅启用客机操作系统功能，查看可用选项的列表。启动磁盘的客机操作系统功能。

字段
type

string

受支持功能的 ID。请参阅启用客机操作系统功能，查看可用选项的列表。

有效值：

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

LocalDiskInitializeParams

仅限输入。指定将与新实例一起创建的新磁盘的参数。使用初始化参数创建附加到新运行时的启动磁盘或本地 SSD。此属性与来源媒体资源互斥；您只能定义其中一个，而不能同时定义这两个属性。

字段
description

string

可选。创建磁盘时提供此属性。
disk_name

string

可选。指定磁盘名称。如果未指定，则默认使用实例的名称。如果具有实例名称的磁盘已存在于指定可用区/区域中，系统会自动生成一个新名称。
disk_size_gb

int64

可选。指定磁盘的大小（以 2 为底数的 GB 为单位）。如果未指定，则磁盘大小将与映像大小相同（通常为 10 GB）。如果指定，则大小必须等于或大于 10 GB。默认值为 100 GB。
disk_type

DiskType

仅限输入。附加到此实例的启动磁盘的类型，默认为标准永久性磁盘 (PD_STANDARD)。
labels

map<string, string>

可选。要应用于此磁盘的标签。这些标签稍后可以通过 disks.setLabels 方法进行修改。此字段仅适用于永久性磁盘。

DiskType

可能的磁盘类型。

枚举
DISK_TYPE_UNSPECIFIED 未设置磁盘类型。
PD_STANDARD 标准永久性磁盘类型。
PD_SSD SSD 永久性磁盘类型。
PD_BALANCED 平衡永久性磁盘类型。
PD_EXTREME 至尊永久性磁盘类型。

MigrateInstanceRequest

请求将用户管理的笔记本迁移到 Workbench 实例。

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/instances/{instance_id}

必须对指定的资源 name 具有以下一项或多项 IAM 权限才能进行授权：

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

PostStartupScriptOption

可选。指定迁移期间启动后脚本的行为。

PostStartupScriptOption

指定迁移期间启动后脚本的行为。

枚举
POST_STARTUP_SCRIPT_OPTION_UNSPECIFIED 未指定启动后脚本选项。默认值为 POST_STARTUP_SCRIPT_OPTION_SKIP。
POST_STARTUP_SCRIPT_OPTION_SKIP 不将启动脚本迁移到新的 Workbench 实例。
POST_STARTUP_SCRIPT_OPTION_RERUN 以用户管理的笔记本身份重新下载并重新运行相同的启动后脚本。

MigrateInstanceResponse

此类型没有字段。

针对 MigrateInstance 的空白消息响应类型。

MigrateRuntimeRequest

将运行时迁移到 Workbench 实例的请求。

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/runtimes/{runtime_id}

必须对指定的资源 name 具有以下一项或多项 IAM 权限才能进行授权：

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

string

可选。新实例所在的 VPC 的名称。如果运行时使用 Google 管理的网络，则此字段为必需字段。如果运行时使用客户自有网络，则会重复使用同一 VPC，并且此字段必须为空。格式：projects/{project_id}/global/networks/{network_id}
subnet

string

可选。新实例所在的子网的名称。如果运行时使用 Google 管理的网络，则此字段为必需字段。如果运行时使用客户自有网络，则会重复使用同一子网，并且此字段必须为空。格式：projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
service_account

string

可选。当运行时使用“仅限单个用户”模式获取权限时，要包含在新 Workbench 实例的 Compute Engine 实例中的服务账号。如果未指定，则使用 Compute Engine 默认服务账号。当运行时使用服务账号模式获取权限时，它将重复使用同一服务账号，因此该字段必须为空。
request_id

string

可选。幂等请求 UUID。
post_startup_script_option

PostStartupScriptOption

可选。指定迁移期间启动后脚本的行为。

PostStartupScriptOption

指定迁移期间启动后脚本的行为。

枚举
POST_STARTUP_SCRIPT_OPTION_UNSPECIFIED 未指定启动后脚本选项。默认值为 POST_STARTUP_SCRIPT_OPTION_SKIP。
POST_STARTUP_SCRIPT_OPTION_SKIP 不将启动脚本迁移到新的 Workbench 实例。
POST_STARTUP_SCRIPT_OPTION_RERUN 重新下载并重新运行与 Google 管理的笔记本相同的启动后脚本。

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 端点名称。

RegisterInstanceRequest

用于注册笔记本实例的请求。

字段
parent

string

必需。格式：parent=projects/{project_id}/locations/{location}

必须对指定的资源 parent 具有以下 IAM 权限才能进行授权：

  • notebooks.instances.create
instance_id

string

必需。相应实例的用户定义的唯一 ID。instance_id 的长度必须介于 1 到 63 个字符之间，并且只能包含小写字母、数字字符和短划线。第一个字符必须是小写字母，最后一个字符不能是短划线。

ReportInstanceInfoRequest

请求笔记本实例向 Notebooks API 报告信息。

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/instances/{instance_id}
vm_id

string

必需。用于对虚拟机进行身份验证的虚拟机硬件令牌。https://cloud.google.com/compute/docs/instances/verifying-instance-identity
metadata

map<string, string>

报告给 Notebooks API 的元数据。此元数据将合并到实例元数据存储区

ReportRuntimeEventRequest

用于报告受管理的笔记本事件的请求。

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/runtimes/{runtime_id}

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

  • iam.permissions.none
vm_id

string

必需。用于对虚拟机进行身份验证的虚拟机硬件令牌。https://cloud.google.com/compute/docs/instances/verifying-instance-identity
event

Event

必需。要报告的事件。

ReservationAffinity

用于使用可用区级预留的预留亲和性。

字段
consume_reservation_type

Type

可选。要使用的预留类型
key

string

可选。对应于预留资源的标签键。
values[]

string

可选。与预留资源的标签值相对应。

类型

指示是否从预留中消耗容量。

枚举
TYPE_UNSPECIFIED 默认类型。
NO_RESERVATION 不使用任何分配的容量。
ANY_RESERVATION 使用任何可用的预留。
SPECIFIC_RESERVATION 必须使用特定预留中的资源。必须指定用于指定预留的键值字段。

ResetInstanceRequest

请求重置笔记本实例

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/instances/{instance_id}

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

  • notebooks.instances.reset

ResetRuntimeRequest

用于重置受管理的笔记本运行时的请求。

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/runtimes/{runtime_id}

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

  • notebooks.runtimes.reset
request_id

string

幂等请求 UUID。

RollbackInstanceRequest

请求回滚笔记本实例

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/instances/{instance_id}

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

  • iam.permissions.none
target_snapshot

string

必需。用于回滚的快照。示例：projects/test-project/global/snapshots/krwlzipynril。

运行时

托管式笔记本实例的运行时的定义。

字段
name

string

仅限输出。运行时的资源名称。格式：projects/{project}/locations/{location}/runtimes/{runtimeId}
state

State

仅限输出。运行时状态。
health_state

HealthState

仅限输出。运行时 health_state。
access_config

RuntimeAccessConfig

用于访问运行时的配置设置。
software_config

RuntimeSoftwareConfig

运行时中软件的配置设置。
metrics

RuntimeMetrics

仅限输出。包含运行时守护程序指标，例如服务状态和 JupyterLab 统计信息。
create_time

Timestamp

仅限输出。运行时创建时间。
update_time

Timestamp

仅限输出。运行时更新时间。
labels

map<string, string>

可选。要与此受管笔记本或运行时相关联的标签。标签键必须包含 1 到 63 个字符，并且必须符合 RFC 1035 的要求。标签值可以为空，但如果存在，则必须包含 1 到 63 个字符，并且必须符合 RFC 1035。与集群关联的标签不得超过 32 个。
runtime_migration_eligibility

RuntimeMigrationEligibility

仅限输出。检查从 GmN 到 WbI 的迁移可行性。
联合字段 runtime_type。运行时类型；目前仅支持 Compute Engine 虚拟机。runtime_type 只能是下列其中一项：
virtual_machine

VirtualMachine

使用 Compute Engine 虚拟机映像启动受管笔记本实例。
migrated

bool

仅限输出。一个布尔值，用于指示相应笔记本是否已迁移到 Workbench 实例

HealthState

运行时子状态。

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

州

相应运行时的状态定义。

枚举
STATE_UNSPECIFIED 未指定状态。
STARTING 计算层正在启动运行时。该地址尚无法使用。
PROVISIONING 计算层正在安装所需框架，并向笔记本代理注册运行时。无法使用。
ACTIVE 运行时目前正在运行，已准备就绪，可供使用。
STOPPING 控制逻辑正在停止运行时。无法使用。
STOPPED 运行时已停止，无法使用。
DELETING 正在删除运行时。无法使用。
UPGRADING 运行时正在升级，无法使用。
INITIALIZING 正在创建和设置运行时。运行时尚未准备就绪，无法使用。

RuntimeAcceleratorConfig

可使用的硬件加速器类型的定义。请参阅 Compute Engine AcceleratorTypes。示例：

  • nvidia-tesla-k80
  • nvidia-tesla-p100
  • nvidia-tesla-v100
  • nvidia-tesla-p4
  • nvidia-tesla-t4
  • nvidia-tesla-a100
字段
type

AcceleratorType

加速器型号。
core_count

int64

相应加速器的核心数。

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 虚拟工作站。

RuntimeAccessConfig

指定运行时的登录配置

字段
access_type

RuntimeAccessType

相应实例的访问模式类型。
runtime_owner

string

创建后相应运行时的所有者。格式：alias@example.com 目前仅支持一个所有者。
proxy_uri

string

仅限输出。用于访问运行时的代理端点。

RuntimeAccessType

访问运行时的可能方式。身份验证模式。目前仅支持：仅限单个用户。

枚举
RUNTIME_ACCESS_TYPE_UNSPECIFIED 未指定访问权限。
SINGLE_USER 单用户登录。
SERVICE_ACCOUNT 服务账号模式。在服务账号模式下，运行时创建者将指定使用方项目中存在的服务账号。使用“运行时服务账号”字段。访问运行时的用户需要 ActAs（服务账号用户）权限。

RuntimeMetrics

包含运行时守护程序指标，例如操作系统和内核以及会话统计信息。

字段
system_metrics

map<string, string>

仅限输出。系统指标。

RuntimeMigrationEligibility

RuntimeMigrationEligibility 表示从 GmN 到 WbI 的迁移可行性信息。

字段
warnings[]

Warning

仅限输出。迁移期间，某些配置将采用默认设置。
errors[]

Error

仅限输出。某些配置会导致 GmN 不符合自动迁移的条件。需要手动迁移。

错误

迁移错误消息表示，某些配置会导致 GmN 不符合自动迁移的条件。需要手动迁移。

枚举
ERROR_UNSPECIFIED 默认类型。
CUSTOM_CONTAINER 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 配置了启动后脚本。请选择性地提供迁移的 post_startup_script_option。
SINGLE_USER 此 GmN 配置为单用户模式。请选择性地为迁移提供 service_account 选项。

RuntimeShieldedInstanceConfig

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

字段
enable_secure_boot

bool

定义实例是否已启用安全启动。

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

bool

定义实例是否已启用 vTPM。默认处于启用状态。
enable_integrity_monitoring

bool

定义实例是否已启用完整性监控。

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

RuntimeSoftwareConfig

指定运行时内部软件的选择和配置。要在运行时设置的属性。属性键以 key:value 格式指定，例如：

  • idle_shutdown: true
  • idle_shutdown_timeout: 180
  • enable_health_monitoring: true
字段
notebook_upgrade_schedule

string

采用世界协调时间 (UTC) 时区的 Cron 表达式，用于安排实例自动升级。请遵循 cron 格式。
idle_shutdown_timeout

int32

在关闭运行时之前等待的时间（以分钟为单位）。默认值：180 分钟
install_gpu_driver

bool

自动安装 Nvidia 驱动程序。默认值：True
custom_gpu_driver_path

string

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

string

在笔记本实例完全启动后自动运行的 Bash 脚本的路径。该路径必须是网址或 Cloud Storage 路径 (gs://path-to-file/file-name)。
kernels[]

ContainerImage

可选。使用容器映像列表作为笔记本实例中的内核。
post_startup_script_behavior

PostStartupScriptBehavior

启动后脚本的行为。
enable_health_monitoring

bool

验证核心内部服务是否正在运行。默认值：True
idle_shutdown

bool

运行时将在 idle_shutdown_time 后自动关闭。默认值：True
upgradeable

bool

仅限输出。一个布尔值，用于指示映像系列中是否有更新的映像。
disable_terminal

bool

一个布尔值，用于指示 JupyterLab 终端是否可用。默认值：False
version

string

仅限输出。启动映像的版本（例如 M100），来自映像的发布标签。
mixer_disabled

bool

一个布尔值，用于指示是否应停用混音器客户端。默认值：False

PostStartupScriptBehavior

启动后脚本的行为。

枚举
POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED 未指定启动后脚本行为。仅在创建时运行一次。
RUN_EVERY_START 在每次启动时运行创建期间提供的启动后脚本。
DOWNLOAD_AND_RUN_EVERY_START 每次启动时都会下载并运行提供的启动后脚本。

时间表

时间表的定义。

字段
name

string

仅限输出。相应时间表的名称。格式：projects/{project_id}/locations/{location}/schedules/{schedule_id}
display_name

string

仅限输出。用于界面显示的名称。名称只能包含字母数字字符、连字符 - 和下划线 _。
description

string

此环境的简要说明。
state

State
cron_schedule

string

作业将按此时间表（采用 crontab 格式）执行。格式：分钟、小时、月份中的日期、月份、星期几，例如 0 0 * * WED = 每周三。更多示例：https://crontab.guru/examples.html
time_zone

string

cron_schedule 的时区。此字段的值必须是 tz 数据库中的时区名称。TZ 数据库：https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

请注意，某些时区包含夏令时规定。夏令时规则取决于所选的 tz。对于世界协调时间 (UTC)，请使用字符串“utc”。如果未指定时区，则默认使用世界协调时间 (UTC)（也称为 GMT）。
create_time

Timestamp

仅限输出。相应时间表的创建时间。
update_time

Timestamp

仅限输出。上次更新日程的时间。
execution_template

ExecutionTemplate

与相应时间表对应的笔记本执行模板。
recent_executions[]

Execution

仅限输出。由此时间表触发的最新执行名称及其相应状态。

州

作业的状态。

枚举
STATE_UNSPECIFIED 未指定状态。
ENABLED 作业正在正常执行。
PAUSED 作业已被用户暂停，因此不会执行。用户可以使用 Cloud Scheduler 有意暂停作业。
DISABLED 由于出现错误，系统已停用相应作业。用户无法直接将作业设置为停用。
UPDATE_FAILED 因 CloudScheduler.UpdateJob 操作失败而导致的作业状态。如需从此状态恢复作业，请重试 CloudScheduler.UpdateJob，直到收到成功响应。
INITIALIZING 正在创建时间表资源。
DELETING 正在删除时间表资源。

SetInstanceAcceleratorRequest

用于设置实例加速器的请求。

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/instances/{instance_id}

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

  • notebooks.instances.setAccelerator
type

AcceleratorType

必需。相应加速器的类型。
core_count

int64

必需。相应加速器的核心数。请注意，并非所有 type 和 core_count 的组合都是有效的。如需查找有效组合，请参阅 Compute Engine 上的 GPU。不支持 TPU。

SetInstanceLabelsRequest

用于设置实例标签的请求。

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/instances/{instance_id}

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

  • notebooks.instances.setLabels
labels

map<string, string>

要应用于相应实例的标签。这些标签稍后可通过 setLabels 方法进行修改

SetInstanceMachineTypeRequest

用于设置实例机器类型的请求。

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/instances/{instance_id}

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

  • notebooks.instances.setMachineType
machine_type

string

必需。Compute Engine 机器类型。

StartInstanceRequest

启动笔记本实例的请求

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/instances/{instance_id}

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

  • notebooks.instances.start

StartRuntimeRequest

用于启动受管笔记本运行时的请求。

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/runtimes/{runtime_id}

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

  • notebooks.runtimes.start
request_id

string

幂等请求 UUID。

StopInstanceRequest

停止笔记本实例的请求

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/instances/{instance_id}

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

  • notebooks.instances.stop

StopRuntimeRequest

停止受管笔记本运行时的请求。

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/runtimes/{runtime_id}

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

  • notebooks.runtimes.stop
request_id

string

幂等请求 UUID。

SwitchRuntimeRequest

切换受管笔记本运行时的请求。

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/runtimes/{runtime_id}

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

  • notebooks.runtimes.switch
machine_type

string

机器类型。
accelerator_config

RuntimeAcceleratorConfig

加速器配置。
request_id

string

幂等请求 UUID。

UpdateInstanceConfigRequest

用于更新实例配置的请求。

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/instances/{instance_id}

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

  • notebooks.instances.updateConfig
config

InstanceConfig

要更新的实例配置。

UpdateInstanceMetadataItemsRequest

添加/更改实例的元数据项的请求。

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/instances/{instance_id}

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

  • notebooks.instances.updateConfig
items

map<string, string>

要为实例添加/更新的元数据项。

UpdateInstanceMetadataItemsResponse

针对为实例添加/更改元数据项的请求做出的响应。

字段
items

map<string, string>

已添加到元数据或在元数据中更新的商品的映射。

UpdateRuntimeRequest

用于更新受管笔记本配置的请求。

字段
runtime

Runtime

必需。要更新的运行时。

必须对指定的资源 runtime 具有以下 IAM 权限才能进行授权：

  • notebooks.runtimes.update
update_mask

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
request_id

string

幂等请求 UUID。

UpdateShieldedInstanceConfigRequest

用于更新笔记本实例的受防护的实例配置的请求。您只能对已停止的实例使用此方法

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/instances/{instance_id}

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

  • notebooks.instances.updateShieldInstanceConfig
shielded_instance_config

ShieldedInstanceConfig

要更新的 ShieldedInstance 配置。

UpgradeInstanceRequest

用于升级笔记本实例的请求

字段
name

string

必需。格式：projects/{project_id}/locations/{location}/instances/{instance_id}

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

  • notebooks.instances.upgrade
type

UpgradeType

可选。可选的 UpgradeType。设置此字段将搜索其他计算映像来升级此实例。

UpgradeType

可在此实例上使用的升级类型的定义。

枚举
UPGRADE_TYPE_UNSPECIFIED 未指定升级类型。
UPGRADE_FRAMEWORK 升级机器学习框架。
UPGRADE_OS 升级操作系统。
UPGRADE_CUDA 升级 CUDA。
UPGRADE_ALL 升级所有内容（操作系统、框架和 CUDA）。

VirtualMachine

使用虚拟机进行计算的运行时。

字段
instance_name

string

仅限输出。受管 Compute Engine 实例的用户友好名称。
instance_id

string

仅限输出。受管 Compute Engine 实例的唯一标识符。
virtual_machine_config

VirtualMachineConfig

虚拟机配置设置。

VirtualMachineConfig

虚拟机的配置设置。

字段
zone

string

仅限输出。虚拟机所在的可用区。如果使用区域性请求，笔记本服务将选择相应运行时区域中的某个位置。在 GET 请求中，始终会存在可用区。示例：* us-central1-b
machine_type

string

必需。运行时使用的 Compute Engine 机器类型。简称有效。示例：* n1-standard-2 * e2-standard-8
container_images[]

ContainerImage

可选。使用容器映像列表作为笔记本实例中的内核。
data_disk

LocalDisk

必需。数据磁盘选项配置设置。
encryption_config

EncryptionConfig

可选。虚拟机数据磁盘的加密设置。
shielded_instance_config

RuntimeShieldedInstanceConfig

可选。安全强化型虚拟机实例配置设置。
accelerator_config

RuntimeAcceleratorConfig

可选。相应运行时的 Compute Engine 加速器配置。
network

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 管理的网络（网络和子网为空）
  • 使用方项目 VPC（需要网络和子网）。需要配置专用服务访问通道。
  • 共享 VPC（需要网络和子网）。需要配置专用服务访问通道。
subnet

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
internal_ip_only

bool

可选。如果为 true，则运行时将仅具有内部 IP 地址。默认情况下，运行时不受限于内部 IP 地址，并且会为每个虚拟机分配临时外部 IP 地址。此 internal_ip_only 限制只能针对启用子网的网络启用，并且必须将所有依赖项配置为可在没有外部 IP 地址的情况下访问。
tags[]

string

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

map<string, string>

仅限输出。Compute Engine 客机属性。（请参阅项目和实例客机特性）。
metadata

map<string, string>

可选。要添加到虚拟机的 Compute Engine 元数据条目。（请参阅项目和实例元数据）。
labels

map<string, string>

可选。要与此运行时相关联的标签。标签键必须包含 1 到 63 个字符，并且必须符合 RFC 1035 的要求。标签值可以为空，但如果存在，则必须包含 1 到 63 个字符，并且必须符合 RFC 1035。与集群关联的标签不得超过 32 个。
nic_type

NicType

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

string

可选。预留的 IP 范围名称已用于 VPC 对等互连。如果分配了子网，则子网分配将使用范围 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
boot_image

BootImage

可选。用于运行时可升级性的启动映像元数据。

BootImage

此类型没有字段。

运行时使用的启动映像的定义。用于实现运行时可升级性。

NicType

vNIC 驱动程序的类型。默认值应为 UNSPECIFIED_NIC_TYPE。

枚举
UNSPECIFIED_NIC_TYPE 未指定类型。
VIRTIO_NET VIRTIO
GVNIC GVNIC

VmImage

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

字段
project

string

必需。相应虚拟机映像所属的 Google Cloud 项目的名称。格式：{project_id}
联合字段 image。对外部 Compute Engine 虚拟机映像的引用。image 只能是下列其中一项：
image_name

string

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

string

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