Checks whether a notebook instance is upgradable.
HTTP request
GET https://notebooks.googleapis.com/v1/{notebookInstance}:isUpgradeable
Path parameters
Parameters | |
---|---|
notebook |
Required. Format: Authorization requires the following IAM permission on the specified resource
|
Query parameters
Parameters | |
---|---|
type |
Optional. The optional UpgradeType. Setting this field will search for additional compute images to upgrade this instance. |
Request body
The request body must be empty.
Response body
Response for checking if a notebook instance is upgradeable.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "upgradeable": boolean, "upgradeVersion": string, "upgradeInfo": string, "upgradeImage": string } |
Fields | |
---|---|
upgradeable |
If an instance is upgradeable. |
upgrade |
The version this instance will be upgraded to if calling the upgrade endpoint. This field will only be populated if field upgradeable is true. |
upgrade |
Additional information about upgrade. |
upgrade |
The new image self link this instance will be upgraded to if calling the upgrade endpoint. This field will only be populated if field upgradeable is true. |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.