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
停止代管 Notebooks 執行階段。
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
列出指定專案和位置中的排程。