Method: projects.locations.instances.migrate

既存のユーザー管理ノートブックを Workbench インスタンスに移行します。

HTTP リクエスト

POST https://notebooks.googleapis.com/v1/{name}:migrate

パスパラメータ

パラメータ
name

string

必須。形式: projects/{projectId}/locations/{location}/instances/{instanceId}

承認には、指定されたリソース name に対する次の IAM 権限のうち 1 つ以上が必要です。

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

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現
{
  "postStartupScriptOption": enum (PostStartupScriptOption)
}
フィールド
postStartupScriptOption

enum (PostStartupScriptOption)

省略可。移行中の起動スクリプトの動作を指定します。

レスポンスの本文

成功した場合、レスポンスの本文には Operation のインスタンスが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳細については、Authentication Overview をご覧ください。

PostStartupScriptOption

移行中の起動スクリプトの動作を指定します。

列挙型
POST_STARTUP_SCRIPT_OPTION_UNSPECIFIED 起動スクリプト後のオプションが指定されていません。デフォルトは POST_STARTUP_SCRIPT_OPTION_SKIP です。
POST_STARTUP_SCRIPT_OPTION_SKIP 起動スクリプトを新しい Workbench インスタンスに移行しない。
POST_STARTUP_SCRIPT_OPTION_RERUN ユーザー管理ノートブックと同じ起動スクリプトを再ダウンロードして再実行します。