Returns various configuration parameters.
HTTP request
GET https://notebooks.googleapis.com/v2/{name}/instances:getConfig
Path parameters
Parameters | |
---|---|
name |
Required. Format: |
Request body
The request body must be empty.
Response body
Response for getting WbI configurations in a location
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "defaultValues": { object ( |
Fields | |
---|---|
defaultValues |
Output only. The default values for configuration. |
supportedValues |
Output only. The supported values for configuration. |
availableImages[] |
Output only. The list of available images to create a WbI. |
disableWorkbenchLegacyCreation |
Output only. Flag to disable the creation of legacy Workbench notebooks (User-managed notebooks and Google-managed notebooks). |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
DefaultValues
DefaultValues represents the default configuration values.
JSON representation |
---|
{ "machineType": string } |
Fields | |
---|---|
machineType |
Output only. The default machine type used by the backend if not provided by the user. |
SupportedValues
SupportedValues represents the values supported by the configuration.
JSON representation |
---|
{ "machineTypes": [ string ], "acceleratorTypes": [ string ] } |
Fields | |
---|---|
machineTypes[] |
Output only. The machine types supported by WbI. |
acceleratorTypes[] |
Output only. The accelerator types supported by WbI. |
ImageRelease
ConfigImage represents an image release available to create a WbI
JSON representation |
---|
{ "imageName": string, "releaseName": string } |
Fields | |
---|---|
imageName |
Output only. The name of the image of the form workbench-instances-vYYYYmmdd- |
releaseName |
Output only. The release of the image of the form m123 |