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

出力専用。画像の説明。