Notebooks API

借助 Notebooks API，您可以在 Google Cloud 中管理 Agent Platform Workbench 资源。

服务：notebooks.googleapis.com

如要调用此服务，我们建议您使用 Google 提供的客户端库。如果您的应用需要使用您自己的库来调用此服务，则在发出 API 请求时应使用以下信息。

发现文档

发现文档是用于说明和使用 REST API 的机器可读规范。它用于构建客户端库、IDE 插件以及与 Google API 交互的其他工具。一项服务可能会提供多个发现文档。此服务提供了以下发现文档：

服务端点

服务端点是指定 API 服务的网络地址的基本网址。一项服务可能有多个服务端点。此服务具有以下服务端点，下面的所有 URI 都与此服务端点相关：

  • https://notebooks.googleapis.com

REST 资源：v2.projects.locations

方法
get GET /v2/{name}
获取位置相关信息。
list GET /v2/{name}/locations
列出有关此服务所支持位置的信息。

REST 资源：v2.projects.locations.instances

方法
checkUpgradability GET /v2/{notebookInstance}:checkUpgradability
检查笔记本实例是否可升级。
create POST /v2/{parent}/instances
在给定的项目和位置中创建一个新实例。
delete DELETE /v2/{name}
删除单个实例。
diagnose POST /v2/{name}:diagnose
根据实例创建诊断文件并运行诊断工具。
get GET /v2/{name}
获取单个实例的详细信息。
getConfig GET /v2/{name}/instances:getConfig
返回各种配置参数。
getIamPolicy GET /v2/{resource}:getIamPolicy
获取资源的访问权限控制政策。
list GET /v2/{parent}/instances
列出给定项目和位置中的实例。
patch PATCH /v2/{instance.name}
UpdateInstance 会更新实例。
reset POST /v2/{name}:reset
重置笔记本实例。
resizeDisk POST /v2/{notebookInstance}:resizeDisk
将笔记本实例磁盘的大小调整为更高的容量。
restore POST /v2/{name}:restore
RestoreInstance 会从 BackupSource 恢复实例。
rollback POST /v2/{name}:rollback
将笔记本实例回滚到先前版本。
setIamPolicy POST /v2/{resource}:setIamPolicy
设置对指定资源的访问权限控制政策。
start POST /v2/{name}:start
启动笔记本实例。
stop POST /v2/{name}:stop
停止笔记本实例。
testIamPermissions POST /v2/{resource}:testIamPermissions
返回调用者对指定资源拥有的权限。
upgrade POST /v2/{name}:upgrade
将笔记本实例升级到最新版本。

REST 资源：v2.projects.locations.operations

方法
cancel POST /v2/{name}:cancel
对长时间运行的操作启动异步取消。
delete DELETE /v2/{name}
删除长时间运行的操作。
get GET /v2/{name}
获取长时间运行的操作的最新状态。
list GET /v2/{name}/operations
列出与请求中指定的过滤条件匹配的操作。

REST 资源：v1.projects.locations

方法
get GET /v1/{name}
获取位置相关信息。
list GET /v1/{name}/locations
列出有关此服务所支持位置的信息。

REST 资源：v1.projects.locations.environments

方法
create POST /v1/{parent}/environments
创建新环境。
delete DELETE /v1/{name}
删除单个环境。
get GET /v1/{name}
获取单个环境的详细信息。
list GET /v1/{parent}/environments
列出项目中的环境。

REST 资源：v1.projects.locations.executions

方法
create POST /v1/{parent}/executions
在给定的项目和位置中创建新的执行。
delete DELETE /v1/{name}
删除执行
get GET /v1/{name}
获取执行的详细信息
list GET /v1/{parent}/executions
列出给定项目和位置中的执行

REST 资源：v1.projects.locations.instances

方法
create POST /v1/{parent}/instances
在给定的项目和位置中创建一个新实例。
delete DELETE /v1/{name}
删除单个实例。
diagnose POST /v1/{name}:diagnose
根据实例创建诊断文件并运行诊断工具。
get GET /v1/{name}
获取单个实例的详细信息。
getIamPolicy GET /v1/{resource}:getIamPolicy
获取资源的访问权限控制政策。
getInstanceHealth GET /v1/{name}:getInstanceHealth
检查笔记本实例的运行状况是否良好。
isUpgradeable GET /v1/{notebookInstance}:isUpgradeable
检查笔记本实例是否可升级。
list GET /v1/{parent}/instances
列出给定项目和位置中的实例。
migrate POST /v1/{name}:migrate
将现有的用户管理的笔记本迁移到 Workbench 实例。
register POST /v1/{parent}/instances:register
向 Notebooks API 服务器注册现有的旧版笔记本实例。
report POST /v1/{name}:report
允许笔记本实例向 Notebooks API 服务器报告其最新的实例信息。
reset POST /v1/{name}:reset
重置笔记本实例。
rollback POST /v1/{name}:rollback
将笔记本实例回滚到先前版本。
setAccelerator PATCH /v1/{name}:setAccelerator
更新单个实例的客户加速器。
setIamPolicy POST /v1/{resource}:setIamPolicy
设置对指定资源的访问权限控制政策。
setLabels PATCH /v1/{name}:setLabels
替换实例的所有标签。
setMachineType PATCH /v1/{name}:setMachineType
更新单个实例的机器类型。
start POST /v1/{name}:start
启动笔记本实例。
stop POST /v1/{name}:stop
停止笔记本实例。
testIamPermissions POST /v1/{resource}:testIamPermissions
返回调用者对指定资源拥有的权限。
updateConfig PATCH /v1/{name}:updateConfig
更新笔记本实例配置。
updateMetadataItems PATCH /v1/{name}:updateMetadataItems
为实例添加/更新元数据项。
updateShieldedInstanceConfig PATCH /v1/{name}:updateShieldedInstanceConfig
更新单个实例的受防护的实例配置。
upgrade POST /v1/{name}:upgrade
将笔记本实例升级到最新版本。

REST 资源：v1.projects.locations.operations

方法
cancel POST /v1/{name}:cancel
对长时间运行的操作启动异步取消。
delete DELETE /v1/{name}
删除长时间运行的操作。
get GET /v1/{name}
获取长时间运行的操作的最新状态。
list GET /v1/{name}/operations
列出与请求中指定的过滤条件匹配的操作。

REST 资源：v1.projects.locations.runtimes

方法
create POST /v1/{parent}/runtimes
在给定的项目和位置中创建新的运行时。
delete DELETE /v1/{name}
删除单个运行时。
get GET /v1/{name}
获取单个运行时的详细信息。
getIamPolicy GET /v1/{resource}:getIamPolicy
获取资源的访问权限控制政策。
list GET /v1/{parent}/runtimes
列出给定项目和位置中的运行时。
migrate POST /v1/{name}:migrate
将现有运行时迁移到新的 Workbench 实例。
patch PATCH /v1/{runtime.name}
更新笔记本运行时配置。
reportEvent POST /v1/{name}:reportEvent
报告并处理运行时事件。
reset POST /v1/{name}:reset
重置托管式笔记本运行时。
setIamPolicy POST /v1/{resource}:setIamPolicy
设置对指定资源的访问权限控制政策。
start POST /v1/{name}:start
启动代管式笔记本运行时。
stop POST /v1/{name}:stop
停止代管式笔记本运行时。
switch POST /v1/{name}:switch
切换托管式笔记本运行时。
testIamPermissions POST /v1/{resource}:testIamPermissions
返回调用者对指定资源拥有的权限。

REST 资源：v1.projects.locations.schedules

方法
create POST /v1/{parent}/schedules
在给定的项目和位置中创建新的已安排的笔记本。
delete DELETE /v1/{name}
删除时间表和所有底层作业
get GET /v1/{name}
获取时间表的详细信息
list GET /v1/{parent}/schedules
列出给定项目和位置中的时间表。