Method: projects.locations.instances.upgrade

ノートブック インスタンスを最新バージョンにアップグレードします。

HTTP リクエスト

POST https://notebooks.googleapis.com/v2/{name}:upgrade

パスパラメータ

パラメータ
name

string

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

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • notebooks.instances.upgrade

リクエストの本文

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

JSON 表現
{
  "imageFamily": string
}
フィールド
imageFamily

string

省略可。アップグレードする Compute Engine イメージ ファミリーのリソース名。形式: projects/{projectId}/global/images/family/{imageFamily} 指定した場合、インスタンスは指定されたイメージ ファミリーの最新のイメージにアップグレードされ、イメージ ファミリー間のアップグレードが可能になります。指定しない場合、インスタンスは現在のイメージ ファミリーの最新のイメージにアップグレードされます。

レスポンスの本文

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

認可スコープ

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

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

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