Method: projects.locations.instances.isUpgradeable

ノートブック インスタンスをアップグレードできるかどうかを確認します。

HTTP リクエスト

GET https://notebooks.googleapis.com/v1/{notebookInstance}:isUpgradeable

パスパラメータ

パラメータ
notebookInstance

string

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

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

  • notebooks.instances.checkUpgradability

クエリ パラメータ

パラメータ
type

enum (UpgradeType)

省略可。省略可能な UpgradeType。このフィールドを設定すると、このインスタンスをアップグレードするための追加のコンピューティング イメージが検索されます。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

ノートブック インスタンスがアップグレード可能かどうかを確認するレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "upgradeable": boolean,
  "upgradeVersion": string,
  "upgradeInfo": string,
  "upgradeImage": string
}
フィールド
upgradeable

boolean

インスタンスがアップグレード可能かどうか。
upgradeVersion

string

アップグレード エンドポイントを呼び出す場合に、このインスタンスがアップグレードされるバージョン。このフィールドは、field upgradeable が true の場合にのみ入力されます。
upgradeInfo

string

アップグレードに関する追加情報。
upgradeImage

string

アップグレード エンドポイントを呼び出す場合に、このインスタンスがアップグレードされる新しいイメージのセルフリンク。このフィールドは、field upgradeable が true の場合にのみ入力されます。

認可スコープ

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

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

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