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

如需了解详情，请参阅 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
}
字段
imageName

string

仅限输出。映像的名称，格式为 workbench-instances-vYYYYmmdd--
releaseName

string

仅限输出。表单 m123 的图片发布