Notebooks API

Notebooks API を使用すると、Google Cloud で Agent Platform Workbench リソースを管理できます。

サービス: notebooks.googleapis.com

このサービスを呼び出すには、Google が提供するクライアント ライブラリを使用することをおすすめします。アプリケーションで独自のライブラリを使用してこのサービスを呼び出す必要がある場合は、API リクエストの際に次の情報を使用してください。

ディスカバリ ドキュメント

ディスカバリ ドキュメントは、REST API を記述して使用するための機械で読み取り可能仕様です。クライアント ライブラリ、IDE プラグイン、Google API と連携するその他のツールのビルドに使用されます。1 つのサービスで複数のディスカバリ ドキュメントを提供できます。このサービスには、次のディスカバリ ドキュメントが用意されています。

サービス エンドポイント

サービス エンドポイントは、API サービスのネットワーク アドレスを指定するベース URL です。1 つのサービスに複数のサービス エンドポイントが存在することもあります。このサービスには次のサービス エンドポイントがあり、以下のすべての 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}
1 つのインスタンスを削除します。
diagnose POST /v2/{name}:diagnose
インスタンスを指定して、診断ファイルを作成し、診断ツールを実行します。
get GET /v2/{name}
1 つのインスタンスの詳細を取得します。
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}
1 つの環境を削除します。
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}
1 つのインスタンスを削除します。
diagnose POST /v1/{name}:diagnose
インスタンスを指定して、診断ファイルを作成し、診断ツールを実行します。
get GET /v1/{name}
1 つのインスタンスの詳細を取得します。
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
指定されたプロジェクトとロケーションに新しい Runtime を作成します。
delete DELETE /v1/{name}
1 つの Runtime を削除します。
get GET /v1/{name}
1 つのランタイムの詳細を取得します。
getIamPolicy GET /v1/{resource}:getIamPolicy
リソースのアクセス制御ポリシーを取得します。
list GET /v1/{parent}/runtimes
指定されたプロジェクトとロケーションの Runtime を一覧表示します。
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
指定されたプロジェクトとロケーションのスケジュールを一覧表示します。