Method: projects.locations.runtimes.migrate

既存のランタイムを新しい Workbench インスタンスに移行します。

HTTP リクエスト

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

パスパラメータ

パラメータ
name

string

必須。形式: projects/{projectId}/locations/{location}/runtimes/{runtimeId}

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

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

リクエストの本文

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

JSON 表現 
{
  "network": string,
  "subnet": string,
  "serviceAccount": string,
  "requestId": string,
  "postStartupScriptOption": enum (PostStartupScriptOption)
}
フィールド
network

string

省略可。新しいインスタンスが存在する VPC の名前。ランタイムで Google マネージド ネットワークを使用する場合は、この設定が必要です。Runtime がお客様所有のネットワークを使用している場合は、同じ VPC が再利用されるため、このフィールドは空にする必要があります。形式: projects/{projectId}/global/networks/{network_id}
subnet

string

省略可。新しいインスタンスが配置されるサブネットの名前。ランタイムで Google マネージド ネットワークを使用する場合は、この設定が必要です。Runtime がお客様所有のネットワークを使用している場合は、同じサブネットが再利用されるため、このフィールドは空にする必要があります。形式: projects/{projectId}/regions/{region}/subnetworks/{subnetwork_id}
serviceAccount

string

省略可。ランタイムが権限に「シングル ユーザーのみ」モードを使用する場合に、新しい Workbench インスタンスの Compute Engine インスタンスに含めるサービス アカウント。指定しない場合は、Compute Engine のデフォルト サービス アカウントが使用されます。ランタイムが権限にサービス アカウント モードを使用する場合、同じサービス アカウントが再利用されるため、このフィールドは空にする必要があります。
requestId

string

省略可。べき等リクエスト UUID。
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 Google マネージド ノートブックと同じ起動スクリプトを再ダウンロードして再実行します。