Method: projects.locations.instances.getConfig

傳回各種設定參數。

HTTP 要求

GET https://notebooks.googleapis.com/v2/{name}/instances:getConfig

路徑參數

參數
name

string

這是必要旗標,格式:projects/{projectId}/locations/{location}

要求主體

要求主體必須為空白。

回應主體

在某個位置取得 WbI 設定的回應

如果成功,回應主體會含有以下結構的資料:

JSON 表示法
{
  "defaultValues": {
    object (DefaultValues)
  },
  "supportedValues": {
    object (SupportedValues)
  },
  "availableImages": [
    {
      object (ImageRelease)
    }
  ],
  "disableWorkbenchLegacyCreation": boolean
}
欄位
defaultValues

object (DefaultValues)

僅供輸出。設定的預設值。

supportedValues

object (SupportedValues)

僅供輸出。設定支援的值。

availableImages[]

object (ImageRelease)

僅供輸出。可建立 WbI 的可用圖片清單。

disableWorkbenchLegacyCreation

boolean

僅供輸出。這個標記可停用舊版 Workbench 筆記本 (使用者自行管理的筆記本和 Google 管理的筆記本) 的建立作業。

授權範圍

需要下列其中一種 OAuth 範圍:

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

詳情請參閱Authentication Overview。

DefaultValues

DefaultValues 代表預設設定值。

JSON 表示法
{
  "machineType": string
}
欄位
machineType

string

僅供輸出。如果使用者未提供,後端使用的預設機型。

SupportedValues

SupportedValues 代表設定支援的值。

JSON 表示法
{
  "machineTypes": [
    string
  ],
  "acceleratorTypes": [
    string
  ]
}
欄位
machineTypes[]

string

僅供輸出。WbI 支援的機型。

acceleratorTypes[]

string

僅供輸出。WbI 支援的加速器類型。

ImageRelease

ConfigImage 代表可用於建立 WbI 的映像檔版本

JSON 表示法
{
  "imageName": string,
  "releaseName": string,
  "imageFamily": string,
  "description": string
}
欄位
imageName

string

僅供輸出。映像檔名稱格式為 workbench-instances-vYYYYmmdd--

releaseName

string

僅供輸出。發布表單 m123 的圖片

imageFamily

string

僅供輸出。圖片的映像檔系列。(例如:workbench-instances 或 workbench-2603)

description

string

僅供輸出。圖片說明。