REST Resource: projects.locations.runtimes

リソース: ランタイム

マネージド ノートブック インスタンスの Runtime の定義。

JSON 表現 
{
  "name": string,
  "state": enum (State),
  "healthState": enum (HealthState),
  "accessConfig": {
    object (RuntimeAccessConfig)
  },
  "softwareConfig": {
    object (RuntimeSoftwareConfig)
  },
  "metrics": {
    object (RuntimeMetrics)
  },
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "runtimeMigrationEligibility": {
    object (RuntimeMigrationEligibility)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "virtualMachine": {
    object (VirtualMachine)
  }
  // End of mutually exclusive fields.
  "migrated": boolean
}
フィールド
name

string

出力専用。ランタイムのリソース名。形式: projects/{project}/locations/{location}/runtimes/{runtimeId}
state

enum (State)

出力専用。ランタイムの状態。
healthState

enum (HealthState)

出力専用。ランタイムの healthState。
accessConfig

object (RuntimeAccessConfig)

ランタイムにアクセスするための構成設定。
softwareConfig

object (RuntimeSoftwareConfig)

ランタイム内のソフトウェアの構成設定。
metrics

object (RuntimeMetrics)

出力専用。サービス ステータスや JupyterLab の統計情報などの Runtime デーモン指標が含まれます。
createTime

string (Timestamp format)

出力専用。ランタイムの作成時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

出力専用。ランタイムの更新時間。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
labels

map (key: string, value: string)

省略可。このマネージド ノートブックまたはランタイムに関連付けるラベル。ラベルのキーは 1 ～ 63 文字で、RFC 1035 に準拠している必要があります。ラベルの値は空にできますが、指定する場合は 1 ～ 63 文字で、RFC 1035 に準拠している必要があります。クラスタに関連付けることができるラベルは 32 個までです。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
runtimeMigrationEligibility

object (RuntimeMigrationEligibility)

出力専用。GmN から WbI への移行の実現可能性を確認します。
ランタイムのタイプ。現在、Compute Engine VM のみがサポートされています。以下は、相互に排他的なフィールドのリストです。レスポンスに設定されるフィールドは、最大 1 つです。
virtualMachine

object (VirtualMachine)

Compute Engine VM イメージを使用して、マネージド ノートブック インスタンスを起動します。
相互に排他的なフィールドの終わり。
migrated

boolean

出力専用。このノートブックが Workbench インスタンスに移行されたかどうかを示すブール値

VirtualMachine

コンピューティングに仮想マシンを使用するランタイム。

JSON 表現 
{
  "instanceName": string,
  "instanceId": string,
  "virtualMachineConfig": {
    object (VirtualMachineConfig)
  }
}
フィールド
instanceName

string

出力専用。マネージド Compute Engine インスタンスのユーザーフレンドリーな名前。
instanceId

string

出力専用。マネージド Compute Engine インスタンスの固有識別子。
virtualMachineConfig

object (VirtualMachineConfig)

仮想マシンの構成設定。

VirtualMachineConfig

仮想マシンの構成設定。

JSON 表現 
{
  "zone": string,
  "machineType": string,
  "containerImages": [
    {
      object (ContainerImage)
    }
  ],
  "dataDisk": {
    object (LocalDisk)
  },
  "encryptionConfig": {
    object (EncryptionConfig)
  },
  "shieldedInstanceConfig": {
    object (RuntimeShieldedInstanceConfig)
  },
  "acceleratorConfig": {
    object (RuntimeAcceleratorConfig)
  },
  "network": string,
  "subnet": string,
  "internalIpOnly": boolean,
  "tags": [
    string
  ],
  "guestAttributes": {
    string: string,
    ...
  },
  "metadata": {
    string: string,
    ...
  },
  "labels": {
    string: string,
    ...
  },
  "nicType": enum (NicType),
  "reservedIpRange": string,
  "bootImage": {
    object (BootImage)
  }
}
フィールド
zone

string

出力専用。仮想マシンが配置されているゾーン。リージョン リクエストを使用している場合、ノートブック サービスは対応するランタイム リージョン内のロケーションを選択します。GET リクエストでは、常にゾーンが存在します。例: * us-central1-b
machineType

string

必須。ランタイムに使用される Compute Engine マシンタイプ。略称は有効です。例: * n1-standard-2 * e2-standard-8
containerImages[]

object (ContainerImage)

省略可。ノートブック インスタンスでカーネルとして使用するコンテナ イメージのリストを使用します。
dataDisk

object (LocalDisk)

必須。データディスク オプションの構成設定。
encryptionConfig

object (EncryptionConfig)

省略可。仮想マシンのデータディスクの暗号化設定。
shieldedInstanceConfig

object (RuntimeShieldedInstanceConfig)

省略可。Shielded VM インスタンスの構成設定。
acceleratorConfig

object (RuntimeAcceleratorConfig)

省略可。このランタイムの Compute Engine アクセラレータ構成。
network

string

省略可。マシン通信に使用する Compute Engine ネットワーク。サブネットワークを指定して指定することはできません。network も subnet も指定されていない場合、プロジェクトの「default」ネットワークが存在すれば、それが使用されます。

完全な URL または部分的な URI。例:

  • https://www.googleapis.com/compute/v1/projects/[projectId]/global/networks/default
  • projects/[projectId]/global/networks/default

ランタイムは、Google インフラストラクチャ内のマネージド リソースです。ランタイムは、次のネットワーク構成をサポートしています。

  • Google マネージド ネットワーク（ネットワークとサブネットが空）
  • コンシューマー プロジェクトの VPC（ネットワークとサブネットは必須）。プライベート サービス アクセスの構成が必要です。
  • 共有 VPC（ネットワークとサブネットが必要です）。プライベート サービス アクセスの構成が必要です。
subnet

string

省略可。マシン通信に使用する Compute Engine サブネットワーク。ネットワークとともに指定することはできません。

完全な URL または部分的な URI が有効です。例:

  • https://www.googleapis.com/compute/v1/projects/[projectId]/regions/us-east1/subnetworks/sub0
  • projects/[projectId]/regions/us-east1/subnetworks/sub0
internalIpOnly

boolean

省略可。true の場合、ランタイムには内部 IP アドレスのみが割り当てられます。デフォルトでは、ランタイムは内部 IP アドレスに制限されず、各 VM にエフェメラル外部 IP アドレスが割り当てられます。この internalIpOnly 制限は、サブネットワークが有効になっているネットワークでのみ有効にできます。また、すべての依存関係が外部 IP アドレスなしでアクセスできるように構成されている必要があります。
tags[]

string

省略可。ランタイムに追加する Compute Engine ネットワーク タグ（ネットワーク タグを追加するをご覧ください）。
guestAttributes

map (key: string, value: string)

出力専用。Compute Engine ゲスト属性。（プロジェクトとインスタンスのゲスト属性をご覧ください）。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
metadata

map (key: string, value: string)

省略可。仮想マシンに追加する Compute Engine メタデータ エントリ。（プロジェクトとインスタンスのメタデータをご覧ください）。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
labels

map (key: string, value: string)

省略可。このランタイムに関連付けるラベル。ラベルのキーは 1 ～ 63 文字で、RFC 1035 に準拠している必要があります。ラベルの値は空にできますが、指定する場合は 1 ～ 63 文字で、RFC 1035 に準拠している必要があります。クラスタに関連付けることができるラベルは 32 個までです。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
nicType

enum (NicType)

省略可。このインターフェースで使用する vNIC のタイプ。gVNIC または VirtioNet のいずれかになります。
reservedIpRange

string

省略可。予約済みの IP 範囲名は、VPC ピアリングに使用されます。割り当てられている場合は、サブネットワークの割り当てで範囲 name が使用されます。

例: managed-notebooks-range-c

PEERING_RANGE_NAME_3=managed-notebooks-range-c
gcloud compute addresses create $PEERING_RANGE_NAME_3 \
  --global \
  --prefix-length=24 \
  --description="Google Cloud Managed Notebooks Range 24 c" \
  --network=$NETWORK \
  --addresses=192.168.0.0 \
  --purpose=VPC_PEERING

フィールド値は managed-notebooks-range-c になります。
bootImage

object (BootImage)

省略可。ランタイムのアップグレード可能性に使用されるブートイメージ メタデータ。

LocalDisk

ローカルにアタッチされたディスク リソース。

JSON 表現 
{
  "autoDelete": boolean,
  "boot": boolean,
  "deviceName": string,
  "guestOsFeatures": [
    {
      object (RuntimeGuestOsFeature)
    }
  ],
  "index": integer,
  "initializeParams": {
    object (LocalDiskInitializeParams)
  },
  "interface": string,
  "kind": string,
  "licenses": [
    string
  ],
  "mode": string,
  "source": string,
  "type": string
}
フィールド
autoDelete

boolean

省略可。出力専用。インスタンスが削除されたときにディスクが自動的に削除されるかどうかを指定します（ディスクがインスタンスから切り離されたときは削除されません）。
boot

boolean

省略可。出力専用。これがブートディスクであることを示します。仮想マシンは、ディスクの最初のパーティションをルート ファイルシステムに使用します。
deviceName

string

省略可。出力専用。インスタンス内で実行されている Linux オペレーティング システムの /dev/disk/by-id/google-* ツリーに反映される、一意のデバイス名を指定します。この名前を使用して、マウントやサイズ変更などのためにインスタンス内からデバイスを参照できます。

指定しない場合、サーバーはこのディスクに適用するデフォルトのデバイス名を選択します。このデバイス名の形式は persistent-disk-x であり、x は Google Compute Engine により割り当てられた番号です。このフィールドは、永続ディスクにのみ適用されます。
guestOsFeatures[]

object (RuntimeGuestOsFeature)

出力専用。ゲスト オペレーティング システムで有効にする機能のリストを示します。ブート可能なイメージにのみ適用されます。使用可能なオプションの一覧については、ゲスト オペレーティング システムの機能を有効にするをご覧ください。
index

integer

出力専用。このディスクの 0 から始まるインデックス。0 はブートディスク用に予約されています。インスタンスに複数のディスクがアタッチされている場合、各ディスクには一意のインデックス番号が割り当てられます。
initializeParams

object (LocalDiskInitializeParams)

入力専用。新しいインスタンスとともに作成される新しいディスクのパラメータを指定します。初期化パラメータを使用して、新しいインスタンスにアタッチされたブートディスクまたはローカル SSD を作成します。

このプロパティは参照元プロパティと相互に排他的です。どちらか一方のみを定義できます。
interface

string

このディスクの接続に使用するディスク インターフェース（SCSI または NVME）を指定します。デフォルトは SCSI です。永続ディスクは常に SCSI を使用する必要があります。SCSI 以外の形式で永続ディスクをアタッチしようとすると、リクエストは失敗します。ローカル SSD は NVMe または SCSI のいずれかを使用できます。NVMe 経由の SCSI のパフォーマンス特性については、ローカル SSD のパフォーマンスをご覧ください。有効な値:

  • NVME
  • SCSI
kind

string

出力専用。リソースのタイプ。アタッチされたディスクの compute#attachedDisk を常に計算します。
licenses[]

string

出力専用。有効な公開ライセンス。
mode

string

このディスクをアタッチするモード（READ_WRITE または READ_ONLY）。指定しない場合、デフォルトではディスクは READ_WRITE モードでアタッチされます。有効な値:

  • READ_ONLY
  • READ_WRITE
source

string

既存の Persistent Disk リソースの有効な部分 URL または完全 URL を指定します。
type

string

ディスクのタイプ（SCRATCH または PERSISTENT）を指定します。指定しない場合、デフォルトは PERSISTENT です。有効な値:

  • PERSISTENT
  • SCRATCH

RuntimeGuestOsFeature

省略可。ゲスト オペレーティング システムで有効にする機能のリスト。ブート可能なイメージにのみ適用されます。使用可能なオプションの一覧については、ゲスト オペレーティング システムの機能を有効にするをご覧ください。ブートディスクのゲスト OS の機能。

JSON 表現 
{
  "type": string
}
フィールド
type

string

サポートされている機能の ID。使用可能なオプションの一覧については、ゲスト オペレーティング システムの機能を有効にするをご覧ください。

有効な値:

  • FEATURE_TYPE_UNSPECIFIED
  • MULTI_IP_SUBNET
  • SECURE_BOOT
  • UEFI_COMPATIBLE
  • VIRTIO_SCSI_MULTIQUEUE
  • WINDOWS

LocalDiskInitializeParams

入力専用。新しいインスタンスとともに作成される新しいディスクのパラメータを指定します。初期化パラメータを使用して、新しいランタイムにアタッチされたブートディスクまたはローカル SSD を作成します。このプロパティは参照元プロパティと相互に排他的です。どちらか一方のみを定義できます。

JSON 表現 
{
  "description": string,
  "diskName": string,
  "diskSizeGb": string,
  "diskType": enum (DiskType),
  "labels": {
    string: string,
    ...
  }
}
フィールド
description

string

省略可。ディスクの作成時にこのプロパティを指定します。
diskName

string

省略可。ディスク名を指定します。指定しない場合、デフォルトではインスタンスの名前が使用されます。インスタンス名と同じ名前のディスクが指定されたゾーン/リージョンにすでに存在する場合は、新しい名前が自動的に生成されます。
diskSizeGb

string (int64 format)

省略可。ディスクのサイズを 2 進数の GB で指定します。指定しない場合、ディスクはイメージと同じサイズ（通常は 10 GB）になります。指定する場合、サイズは 10 GB 以上にする必要があります。デフォルトは 100 GB です。
diskType

enum (DiskType)

入力専用。このインスタンスにアタッチされているブートディスクのタイプ。デフォルトは標準永続ディスク（PD_STANDARD）です。
labels

map (key: string, value: string)

省略可。このディスクに適用するラベル。これらは、disks.setLabels メソッドで後から変更できます。このフィールドは、永続ディスクにのみ適用されます。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

DiskType

使用可能なディスクタイプ。

列挙型
DISK_TYPE_UNSPECIFIED ディスクタイプが設定されていません。
PD_STANDARD 標準永続ディスクタイプ。
PD_SSD SSD 永続ディスクのタイプ。
PD_BALANCED バランス永続ディスクタイプ。
PD_EXTREME エクストリーム永続ディスクタイプ。

EncryptionConfig

リソースに適用できるカスタム暗号鍵構成を表します。これにより、仮想マシン内のすべてのディスクが暗号化されます。

JSON 表現 
{
  "kmsKey": string
}
フィールド
kmsKey

string

ディスクなどのリソースの保護に使用される顧客管理の暗号鍵の Cloud KMS リソース ID。次の形式となります。projects/{PROJECT_ID}/locations/{REGION}/keyRings/{KEY_RING_NAME}/cryptoKeys/{KEY_NAME}

RuntimeShieldedInstanceConfig

一連のシールド インスタンス オプション。サポートされている Shielded VM 機能を使用するイメージをご覧ください。すべての組み合わせが有効なわけではありません。

JSON 表現 
{
  "enableSecureBoot": boolean,
  "enableVtpm": boolean,
  "enableIntegrityMonitoring": boolean
}
フィールド
enableSecureBoot

boolean

インスタンスでセキュアブートを有効にするかどうかを定義します。

セキュアブートは、すべてのブート コンポーネントのデジタル署名を検証し、署名検証が失敗した場合にブートプロセスを停止することで、システムで正規のソフトウェアのみが実行されるようにします。デフォルトでは無効にされています。
enableVtpm

boolean

インスタンスで vTPM が有効になっているかどうかを定義します。デフォルトで有効になっています。
enableIntegrityMonitoring

boolean

インスタンスで整合性モニタリングを有効にするかどうかを定義します。

インスタンスの起動時の整合性のモニタリングと証明書取得を有効にします。構成証明は、整合性ポリシー ベースラインに対して実行されます。このベースラインは、インスタンスの作成時に、暗黙的に信頼されているブートイメージから派生します。デフォルトで有効になっています。

RuntimeAcceleratorConfig

使用できるハードウェア アクセラレータのタイプの定義。Compute Engine の AcceleratorTypes をご覧ください。例:

  • nvidia-tesla-k80
  • nvidia-tesla-p100
  • nvidia-tesla-v100
  • nvidia-tesla-p4
  • nvidia-tesla-t4
  • nvidia-tesla-a100
JSON 表現 
{
  "type": enum (AcceleratorType),
  "coreCount": string
}
フィールド
type

enum (AcceleratorType)

アクセラレータ モデル。
coreCount

string (int64 format)

このアクセラレータのコア数。

AcceleratorType

このアクセラレータのタイプ。

列挙型
ACCELERATOR_TYPE_UNSPECIFIED アクセラレータ タイプが指定されていません。
NVIDIA_TESLA_K80

アクセラレータ タイプは Nvidia Tesla K80 です。
NVIDIA_TESLA_P100 アクセラレータ タイプは Nvidia Tesla P100 です。
NVIDIA_TESLA_V100 アクセラレータのタイプは Nvidia Tesla V100 です。
NVIDIA_TESLA_P4 アクセラレータ タイプは Nvidia Tesla P4 です。
NVIDIA_TESLA_T4 アクセラレータ タイプは Nvidia Tesla T4 です。
NVIDIA_TESLA_A100 アクセラレータ タイプは Nvidia Tesla A100 - 40 GB です。
NVIDIA_L4 アクセラレータ タイプは Nvidia L4 です。
TPU_V2 （近日公開）アクセラレータ タイプは TPU V2 です。
TPU_V3 （近日公開）アクセラレータ タイプは TPU V3 です。
NVIDIA_TESLA_T4_VWS アクセラレータ タイプは NVIDIA Tesla T4 仮想ワークステーションです。
NVIDIA_TESLA_P100_VWS アクセラレータ タイプは NVIDIA Tesla P100 仮想ワークステーションです。
NVIDIA_TESLA_P4_VWS アクセラレータ タイプは NVIDIA Tesla P4 仮想ワークステーションです。

NicType

vNIC ドライバのタイプ。デフォルトは UNSPECIFIED_NIC_TYPE にする必要があります。

列挙型
UNSPECIFIED_NIC_TYPE タイプが指定されていません。
VIRTIO_NET Virtio
GVNIC GVNIC

BootImage

この型にはフィールドがありません。

ランタイムで使用されるブートイメージの定義。ランタイムのアップグレードを容易にするために使用されます。

状態

このランタイムの状態の定義。

列挙型
STATE_UNSPECIFIED 状態が指定されていません。
STARTING コンピューティング レイヤがランタイムを開始しています。使用できる状態になっていません。
PROVISIONING コンピューティング レイヤは、必要なフレームワークをインストールし、ノートブック プロキシにランタイムを登録しています。使用できません。
ACTIVE ランタイムは現在実行中です。使用できる状態になっています。
STOPPING 制御ロジックがランタイムを停止しています。使用できません。
STOPPED ランタイムが停止しています。使用できません。
DELETING ランタイムの削除中です。使用できません。
UPGRADING ランタイムのアップグレード中です。使用できません。
INITIALIZING ランタイムの作成と設定が行われています。使用できる状態になっていません。

HealthState

ランタイム サブステート。

列挙型
HEALTH_STATE_UNSPECIFIED ランタイムのサブステートが不明です。
HEALTHY ランタイムが正常な状態であることがわかっている（たとえば、重要なデーモンが実行されている）。ACTIVE 状態に適用されます。
UNHEALTHY ランタイムが異常な状態であることがわかっている（たとえば、重要なデーモンが実行されていない）。ACTIVE 状態に適用されます。
AGENT_NOT_INSTALLED ランタイムにヘルス モニタリング エージェントがインストールされていません。ACTIVE 状態に適用されます。
AGENT_NOT_RUNNING ランタイム ヘルス モニタリング エージェントが実行されていません。ACTIVE 状態に適用されます。

RuntimeAccessConfig

Runtime のログイン構成を指定します

JSON 表現 
{
  "accessType": enum (RuntimeAccessType),
  "runtimeOwner": string,
  "proxyUri": string
}
フィールド
accessType

enum (RuntimeAccessType)

このインスタンスのアクセスモードのタイプ。
runtimeOwner

string

作成後のこのランタイムのオーナー。形式: alias@example.com 現在、サポートされているオーナーは 1 人のみです。
proxyUri

string

出力専用。ランタイムへのアクセスに使用されるプロキシ エンドポイント。

RuntimeAccessType

ランタイムにアクセスする方法は次のとおりです。認証モード。現在サポートされているのは、シングル ユーザーのみです。

列挙型
RUNTIME_ACCESS_TYPE_UNSPECIFIED アクセスが指定されていません。
SINGLE_USER シングル ユーザー ログイン。
SERVICE_ACCOUNT サービス アカウント モード。サービス アカウント モードでは、ランタイム作成者はコンシューマー プロジェクトに存在する SA を指定します。[ランタイム サービス アカウント] フィールドを使用します。ランタイムにアクセスするユーザーには、ActAs（サービス アカウント ユーザー）権限が必要です。

RuntimeSoftwareConfig

ランタイム内のソフトウェアの選択と構成を指定します。ランタイムに設定するプロパティ。プロパティキーは key:value 形式で指定します。例:

  • idleShutdown: true
  • idleShutdownTimeout: 180
  • enableHealthMonitoring: true
JSON 表現 
{
  "notebookUpgradeSchedule": string,
  "idleShutdownTimeout": integer,
  "installGpuDriver": boolean,
  "customGpuDriverPath": string,
  "postStartupScript": string,
  "kernels": [
    {
      object (ContainerImage)
    }
  ],
  "postStartupScriptBehavior": enum (PostStartupScriptBehavior),
  "enableHealthMonitoring": boolean,
  "idleShutdown": boolean,
  "upgradeable": boolean,
  "disableTerminal": boolean,
  "version": string,
  "mixerDisabled": boolean
}
フィールド
notebookUpgradeSchedule

string

インスタンスの自動アップグレードのスケジュールに使用される UTC タイムゾーンの cron 式。cron 形式に従ってください。
idleShutdownTimeout

integer

ランタイムをシャットダウンするまで待機する時間（分単位）。デフォルト: 180 分
installGpuDriver

boolean

Nvidia ドライバを自動的にインストールします。デフォルト: True
customGpuDriverPath

string

GPU ドライバが保存されているカスタム Cloud Storage パスを指定します。指定しない場合、公式の GPU ドライバから自動的に選択されます。
postStartupScript

string

ノートブック インスタンスが完全に起動した後に自動的に実行される Bash スクリプトのパス。パスは、URL または Cloud Storage パス（gs://path-to-file/file-name）にする必要があります。
kernels[]

object (ContainerImage)

省略可。ノートブック インスタンスでカーネルとして使用するコンテナ イメージのリストを使用します。
postStartupScriptBehavior

enum (PostStartupScriptBehavior)

起動後のスクリプトの動作。
enableHealthMonitoring

boolean

コア内部サービスが実行されていることを確認します。デフォルト: True
idleShutdown

boolean

ランタイムは、idle_shutdown_time の経過後に自動的にシャットダウンされます。デフォルト: True
upgradeable

boolean

出力専用。イメージ ファミリーで新しいイメージが利用可能かどうかを示すブール値。
disableTerminal

boolean

JupyterLab ターミナルが使用可能かどうかを示すブール値。デフォルト: false
version

string

出力専用。イメージのリリースラベルから取得したブートイメージのバージョン（M100 など）。
mixerDisabled

boolean

ミキサー クライアントを無効にするかどうかを示すブール値。デフォルト: false

PostStartupScriptBehavior

起動後のスクリプトの動作。

列挙型
POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED 起動スクリプトの動作が指定されていません。作成時に 1 回だけ実行されます。
RUN_EVERY_START 作成時に指定された起動スクリプトを起動ごとに実行します。
DOWNLOAD_AND_RUN_EVERY_START 起動するたびに、指定された起動スクリプトをダウンロードして実行します。

RuntimeMetrics

OS、カーネル、セッション統計などのランタイム デーモン指標が含まれます。

JSON 表現 
{
  "systemMetrics": {
    string: string,
    ...
  }
}
フィールド
systemMetrics

map (key: string, value: string)

出力専用。システム指標。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

RuntimeMigrationEligibility

RuntimeMigrationEligibility は、GmN から WbI への移行の実現可能性に関する情報を表します。

JSON 表現 
{
  "warnings": [
    enum (Warning)
  ],
  "errors": [
    enum (Error)
  ]
}
フィールド
warnings[]

enum (Warning)

出力専用。移行時に、特定の構成はデフォルト設定になります。
errors[]

enum (Error)

出力専用。特定の構成では、GmN は自動移行の対象外になります。手動移行が必要です。

警告

移行警告メッセージは、移行中に特定の構成がデフォルト設定になることを意味します。

列挙型
WARNING_UNSPECIFIED デフォルトのタイプ。
UNSUPPORTED_ACCELERATOR_TYPE GmN で、WbI でサポートされていないアクセラレータ タイプが使用されています。アクセラレータなしで移行されます。アクセラレータは移行後に接続できます。
UNSUPPORTED_OS GmN が WbI でサポートされていないオペレーティング システム（Debian 10 など）を使用している。WbI では Debian 11 に置き換えられます。
RESERVED_IP_RANGE この GmN は予約済みの IP 範囲で構成されていますが、これは WbI では適用されなくなりました。
GOOGLE_MANAGED_NETWORK この GmN は Google 管理のネットワークで構成されています。移行の network オプションと subnet オプションを指定してください。
POST_STARTUP_SCRIPT この GmN は、起動後のスクリプトで構成されています。必要に応じて、移行の postStartupScriptOption を指定してください。
SINGLE_USER この GmN はシングル ユーザー モードで構成されています。必要に応じて、移行の serviceAccount オプションを指定してください。

エラー

移行エラー メッセージは、特定の構成により GmN が自動移行の対象外になっていることを意味します。手動移行が必要です。

列挙型
ERROR_UNSPECIFIED デフォルトのタイプ。
CUSTOM_CONTAINER GmN はカスタム コンテナで構成されているため、移行できません。

メソッド

create

 指定されたプロジェクトとロケーションに新しい Runtime を作成します。

delete

 1 つのランタイムを削除します。

get

 1 つの Runtime の詳細を取得します。

getIamPolicy

 リソースのアクセス制御ポリシーを取得します。

list

 指定されたプロジェクトとロケーションの Runtime を一覧表示します。

migrate

 既存のランタイムを新しい Workbench インスタンスに移行します。

patch

 ノートブック ランタイム構成を更新します。

reportEvent

 ランタイム イベントを報告して処理します。

reset

 マネージド ノートブック ランタイムをリセットします。

setIamPolicy

 指定したリソースにアクセス制御ポリシーを設定します。

start

 マネージド ノートブック ランタイムを開始します。

stop

 マネージド ノートブック ランタイムを停止します。

switch

 マネージド ノートブック ランタイムを切り替えます。

testIamPermissions

 指定したリソースに対して呼び出し元が持っている権限を返します。