REST Resource: projects.locations.instances

リソース: インスタンス

ノートブック インスタンスの定義。

JSON 表現 
{
  "name": string,
  "proxyUri": string,
  "instanceOwners": [
    string
  ],
  "creator": string,
  "state": enum (State),
  "upgradeHistory": [
    {
      object (UpgradeHistoryEntry)
    }
  ],
  "id": string,
  "healthState": enum (HealthState),
  "healthInfo": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "disableProxyAccess": boolean,
  "labels": {
    string: string,
    ...
  },
  "thirdPartyProxyUrl": string,
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean,
  "enableThirdPartyIdentity": boolean,
  "enableManagedEuc": boolean,
  "enableDeletionProtection": boolean,

  // Union field infrastructure can be only one of the following:
  "gceSetup": {
    object (GceSetup)
  }
  // End of list of possible types for union field infrastructure.
}
フィールド
name

string

出力専用。ID。このノートブック インスタンスの名前。形式: projects/{projectId}/locations/{location}/instances/{instanceId}
proxyUri

string

出力専用。Jupyter ノートブックへのアクセスに使用されるプロキシ エンドポイント。
instanceOwners[]

string

省略可。作成後のこのインスタンスのオーナー。形式: alias@example.com

現在、サポートされているオーナーは 1 人のみです。指定しない場合、VM インスタンスのサービス アカウントのすべてのサービス アカウント ユーザーがインスタンスを使用できます。
creator

string

出力専用。元の instances.create リクエストを送信したエンティティのメールアドレス。
state

enum (State)

出力専用。このインスタンスの状態。
upgradeHistory[]

object (UpgradeHistoryEntry)

出力専用。このインスタンスのアップグレード履歴。
id

string

出力専用。リソースの一意の ID。
healthState

enum (HealthState)

出力専用。インスタンスの healthState。
healthInfo

map (key: string, value: string)

出力専用。インスタンスのヘルス状態に関する追加情報。例:

healthInfo": {
  "docker_proxy_agent_status": "1",
  "docker_status": "1",
  "jupyterlab_api_status": "-1",
  "jupyterlab_status": "-1",
  "updated": "2020-10-18 09:40:03.573409"
}

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
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"。
disableProxyAccess

boolean

省略可。true の場合、ノートブック インスタンスはプロキシに登録されません。
labels

map (key: string, value: string)

省略可。このインスタンスに適用するラベル。これらは、後で instances.patch メソッドで変更できます。

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

string

出力専用。Jupyter Notebook へのアクセスに使用される Workforce プール プロキシ エンドポイント。
satisfiesPzs

boolean

出力専用。ゾーン分離のために将来の使用のために予約されています。
satisfiesPzi

boolean

出力専用。ゾーン分離の将来の使用のために予約されています。
enableThirdPartyIdentity

boolean

省略可。ノートブックにサードパーティ ID プロバイダを使用してアクセスできることを指定するフラグ。
enableManagedEuc

boolean

省略可。インスタンスの管理対象エンドユーザー認証情報を有効にするフラグ。
enableDeletionProtection

boolean

省略可。true の場合、この Workbench インスタンスで削除からの保護が有効になります。false の場合、この Workbench インスタンスの削除からの保護は無効になります。
共用体フィールド infrastructure。ノートブック インスタンスの設定。infrastructure は次のいずれかになります。
gceSetup

object (GceSetup)

省略可。ノートブックの Compute Engine の設定。ノートブックで定義されたフィールドを使用します。

GceSetup

リソースと ID の外部で VM インスタンスを構成する方法の定義。

JSON 表現 
{
  "machineType": string,
  "minCpuPlatform": string,
  "acceleratorConfigs": [
    {
      object (AcceleratorConfig)
    }
  ],
  "serviceAccounts": [
    {
      object (ServiceAccount)
    }
  ],
  "bootDisk": {
    object (BootDisk)
  },
  "dataDisks": [
    {
      object (DataDisk)
    }
  ],
  "shieldedInstanceConfig": {
    object (ShieldedInstanceConfig)
  },
  "networkInterfaces": [
    {
      object (NetworkInterface)
    }
  ],
  "disablePublicIp": boolean,
  "tags": [
    string
  ],
  "metadata": {
    string: string,
    ...
  },
  "enableIpForwarding": boolean,
  "gpuDriverConfig": {
    object (GPUDriverConfig)
  },
  "confidentialInstanceConfig": {
    object (ConfidentialInstanceConfig)
  },
  "instanceId": string,

  // Union field image can be only one of the following:
  "vmImage": {
    object (VmImage)
  },
  "containerImage": {
    object (ContainerImage)
  }
  // End of list of possible types for union field image.
}
フィールド
machineType

string

省略可。VM インスタンスのマシンタイプ。https://cloud.google.com/compute/docs/machine-resource
minCpuPlatform

string

省略可。このインスタンスで使用する最小 CPU プラットフォーム。有効な値のリストは、https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform#availablezones で確認できます。
acceleratorConfigs[]

object (AcceleratorConfig)

省略可。このインスタンスで使用されるハードウェア アクセラレータ。アクセラレータを使用する場合は、選択した machineType をサポートするのに十分な vCPU とメモリが構成に含まれていることを確認してください。現在、サポートされているアクセラレータ構成は 1 つのみです。
serviceAccounts[]

object (ServiceAccount)

省略可。VM インスタンスの ID として機能するサービス アカウント。現在、サポートされているサービス アカウントは 1 つのみです。
bootDisk

object (BootDisk)

省略可。VM のブートディスク。
dataDisks[]

object (DataDisk)

省略可。VM インスタンスにアタッチされたデータディスク。現在サポートされているデータディスクは 1 つのみです。
shieldedInstanceConfig

object (ShieldedInstanceConfig)

省略可。Shielded VM の構成。サポートされている Shielded VM 機能を使用するイメージ。
networkInterfaces[]

object (NetworkInterface)

省略可。VM のネットワーク インターフェース。サポートされるインターフェースは 1 つのみです。
disablePublicIp

boolean

省略可。true の場合、この VM インスタンスに外部 IP は割り当てられません。
tags[]

string

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

map (key: string, value: string)

省略可。このインスタンスに適用するカスタム メタデータ。

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

boolean

省略可。IP 転送を有効にするかどうかを示すフラグ。デフォルトは false（オフ）です。https://cloud.google.com/vpc/docs/using-routes#canipforward
gpuDriverConfig

object (GPUDriverConfig)

省略可。GPU ドライバの構成。
confidentialInstanceConfig

object (ConfidentialInstanceConfig)

省略可。機密インスタンスの構成。
instanceId

string

出力専用。Compute Engine インスタンス リソースの一意の ID。
共用体フィールド image。イメージのタイプ。VM イメージまたはコンテナ イメージのいずれかになります。image は次のいずれかになります。
vmImage

object (VmImage)

省略可。Compute Engine VM イメージを使用してノートブック インスタンスを起動します。
containerImage

object (ContainerImage)

省略可。コンテナ イメージを使用してノートブック インスタンスを起動します。

AcceleratorConfig

VM インスタンスのアクセラレータ構成。ハードウェア アクセラレータの定義。type と coreCount の組み合わせはチェックされません。TPU はサポートされていません。有効な組み合わせについては、Compute Engine の GPU をご覧ください。

JSON 表現 
{
  "type": enum (AcceleratorType),
  "coreCount": string
}
フィールド
type

enum (AcceleratorType)

省略可。このアクセラレータのタイプ。
coreCount

string (int64 format)

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

AcceleratorType

このインスタンスで使用できるハードウェア アクセラレータのタイプの定義。

列挙型
ACCELERATOR_TYPE_UNSPECIFIED アクセラレータ タイプが指定されていません。
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_A100_80GB アクセラレータ タイプは Nvidia Tesla A100 - 80 GB です。
NVIDIA_L4 アクセラレータ タイプは Nvidia Tesla L4 です。
NVIDIA_H100_80GB アクセラレータ タイプは Nvidia Tesla H100 - 80 GB です。
NVIDIA_H100_MEGA_80GB アクセラレータ タイプは Nvidia Tesla H100 - MEGA 80 GB です。
NVIDIA_H200_141GB アクセラレータ タイプは Nvidia Tesla H200 - 141 GB です。
NVIDIA_TESLA_T4_VWS アクセラレータ タイプは NVIDIA Tesla T4 仮想ワークステーションです。
NVIDIA_TESLA_P100_VWS アクセラレータ タイプは NVIDIA Tesla P100 仮想ワークステーションです。
NVIDIA_TESLA_P4_VWS アクセラレータ タイプは NVIDIA Tesla P4 仮想ワークステーションです。
NVIDIA_B200 アクセラレータ タイプは NVIDIA B200 です。

ServiceAccount

ID として機能するサービス アカウント。

JSON 表現 
{
  "email": string,
  "scopes": [
    string
  ]
}
フィールド
email

string

省略可。サービス アカウントのメールアドレス。
scopes[]

string

出力専用。このサービス アカウントで使用可能にするスコープのリスト。CLH によって https://www.googleapis.com/auth/cloud-platform に設定されます。

VmImage

環境が VM に直接インストールされたノートブック インスタンスを起動するためのカスタム Compute Engine 仮想マシン イメージの定義。

JSON 表現 
{
  "project": string,

  // Union field image can be only one of the following:
  "name": string,
  "family": string
  // End of list of possible types for union field image.
}
フィールド
project

string

必須。この VM イメージが属する Google Cloud プロジェクトの名前。形式: {projectId}
共用体フィールド image。外部の Compute Engine VM イメージへの参照。image は次のいずれかになります。
name

string

省略可。VM イメージ名を使用してイメージを見つけます。
family

string

省略可。この VM イメージ ファミリーを使用してイメージを検索します。このファミリーの最新のイメージが使用されます。

ContainerImage

コンテナにインストールされた環境でノートブック インスタンスを起動するためのコンテナ イメージの定義。

JSON 表現 
{
  "repository": string,
  "tag": string
}
フィールド
repository

string

必須。コンテナ イメージ リポジトリのパス。例: gcr.io/{projectId}/{imageName}
tag

string

省略可。コンテナ イメージのタグ。指定しない場合、デフォルトで最新のタグが使用されます。

BootDisk

ブートディスクの定義。

JSON 表現 
{
  "diskSizeGb": string,
  "diskType": enum (DiskType),
  "diskEncryption": enum (DiskEncryption),
  "kmsKey": string
}
フィールド
diskSizeGb

string (int64 format)

省略可。このインスタンスにアタッチされているブートディスクのサイズ（GB 単位）。最大 64, 000 GB（64 TB）まで。指定しない場合、デフォルトは推奨値の 150 GB になります。
diskType

enum (DiskType)

省略可。ディスクのタイプを示します。
diskEncryption

enum (DiskEncryption)

省略可。入力専用。ブートディスクとデータディスクで使用されるディスク暗号化方式。デフォルトは GMEK です。
kmsKey

string

省略可。入力専用。ディスクの暗号化に使用される KMS 鍵。diskEncryption が CMEK の場合にのみ適用されます。形式: projects/{projectId}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

独自の暗号鍵の使用について学習する。

DiskType

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

列挙型
DISK_TYPE_UNSPECIFIED ディスクタイプが設定されていません。
PD_STANDARD 標準永続ディスクタイプ。
PD_SSD SSD 永続ディスクのタイプ。
PD_BALANCED バランス永続ディスクタイプ。
PD_EXTREME エクストリーム永続ディスクタイプ。
HYPERDISK_BALANCED Hyperdisk Balanced 永続ディスクタイプを表します。ブートディスクまたはデータディスクとして使用できます。
HYPERDISK_EXTREME Hyperdisk Extreme 永続ディスク タイプを表します。データディスクとしてのみ使用できます。
HYPERDISK_THROUGHPUT Hyperdisk Throughput 永続ディスク タイプを表します。データディスクとしてのみ使用できます。
HYPERDISK_BALANCED_HIGH_AVAILABILITY Hyperdisk Balanced High Availability 永続ディスク タイプを表します。ブートディスクまたはデータディスクとして使用できます。
HYPERDISK_ML Hyperdisk ML 永続ディスク タイプを表します。ブートディスクまたはデータディスクとして使用できます。

DiskEncryption

ディスク暗号化オプションの定義。

列挙型
DISK_ENCRYPTION_UNSPECIFIED ディスク暗号化が指定されていません。
GMEK Google が管理する暗号鍵を使用してブートディスクを暗号化します。
CMEK 顧客管理の暗号鍵を使用してブートディスクを暗号化します。

DataDisk

インスタンスにアタッチされたディスク リソース。

JSON 表現 
{
  "diskSizeGb": string,
  "diskType": enum (DiskType),
  "diskEncryption": enum (DiskEncryption),
  "kmsKey": string,
  "resourcePolicies": [
    string
  ]
}
フィールド
diskSizeGb

string (int64 format)

省略可。この VM インスタンスに接続されているディスクのサイズ（GB 単位）。最大 64, 000 GB（64 TB）まで。指定しない場合、デフォルトは 100 です。
diskType

enum (DiskType)

省略可。入力専用。ディスクのタイプを示します。
diskEncryption

enum (DiskEncryption)

省略可。入力専用。ブートディスクとデータディスクで使用されるディスク暗号化方式。デフォルトは GMEK です。
kmsKey

string

省略可。入力専用。ディスクの暗号化に使用される KMS 鍵。diskEncryption が CMEK の場合にのみ適用されます。形式: projects/{projectId}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

独自の暗号鍵の使用について学習する。
resourcePolicies[]

string

省略可。データディスクに適用するリソース ポリシー。

ShieldedInstanceConfig

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

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

boolean

省略可。VM インスタンスでセキュアブートが有効になっているかどうかを定義します。

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

boolean

省略可。VM インスタンスで vTPM が有効になっているかどうかを定義します。
enableIntegrityMonitoring

boolean

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

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

NetworkInterface

VM にアタッチされたネットワーク インターフェース リソースの定義。

JSON 表現 
{
  "network": string,
  "subnet": string,
  "nicType": enum (NicType),
  "accessConfigs": [
    {
      object (AccessConfig)
    }
  ]
}
フィールド
network

string

省略可。この VM インスタンスが存在する VPC の名前。形式: projects/{projectId}/global/networks/{network_id}
subnet

string

省略可。この VM インスタンスが存在するサブネットの名前。形式: projects/{projectId}/regions/{region}/subnetworks/{subnetwork_id}
nicType

enum (NicType)

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

object (AccessConfig)

省略可。このインターフェースの構成の配列。現在、サポートされているアクセス構成は ONE_TO_ONE_NAT のみです。accessConfigs が指定されていない場合、インスタンスはエフェメラル外部 IP アドレスを介して外部インターネットにアクセスします。

NicType

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

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

AccessConfig

インスタンスのネットワーク インターフェースに接続されたアクセス構成。

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

string

このインスタンスに関連付けられている外部 IP アドレス。プロジェクトで使用可能な未使用の静的外部 IP アドレスを指定するか、このフィールドを未定義のままにして、共有エフェメラル IP アドレスプールの IP を使用します。静的外部 IP アドレスを指定する場合は、インスタンスのゾーンと同じリージョンに存在している必要があります。

GPUDriverConfig

GPU ドライバの構成

JSON 表現 
{
  "enableGpuDriver": boolean,
  "customGpuDriverPath": string
}
フィールド
enableGpuDriver

boolean

省略可。エンドユーザーが Google Cloud にこの VM インスタンスへの GPU ドライバのインストールを承認するかどうか。このフィールドが空の場合や false に設定されている場合、GPU ドライバはインストールされません。GPU を使用するインスタンスにのみ適用されます。
customGpuDriverPath

string

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

ConfidentialInstanceConfig

一連の Confidential Instance オプション。

JSON 表現 
{
  "confidentialInstanceType": enum (ConfidentialInstanceType)
}
フィールド
confidentialInstanceType

enum (ConfidentialInstanceType)

省略可。機密インスタンスで使用されるテクノロジーのタイプを定義します。

ConfidentialInstanceType

機密インスタンスのタイプ。

列挙型
CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED タイプが指定されていません。この値は使用しないでください。
SEV AMD Secure Encrypted Virtualization。

状態

このインスタンスの状態の定義。

列挙型
STATE_UNSPECIFIED 状態が指定されていません。
STARTING 制御ロジックがインスタンスを起動しています。
PROVISIONING 制御ロジックは、必要なフレームワークをインストールし、インスタンスをノートブック プロキシに登録します。
ACTIVE インスタンスは実行中です。
STOPPING 制御ロジックがインスタンスを停止しています。
STOPPED インスタンスは停止しています。
DELETED インスタンスが削除された場合。
UPGRADING インスタンスがアップグレード中です。
INITIALIZING インスタンスを作成しています。
SUSPENDING インスタンスは一時停止中です。
SUSPENDED インスタンスは一時停止されています。

UpgradeHistoryEntry

VM イメージのアップグレード履歴のエントリ。

JSON 表現 
{
  "snapshot": string,
  "vmImage": string,
  "containerImage": string,
  "framework": string,
  "version": string,
  "state": enum (State),
  "createTime": string,
  "action": enum (Action),
  "targetVersion": string
}
フィールド
snapshot

string

省略可。アップグレード前のこのノートブック インスタンスのブートディスクのスナップショット。
vmImage

string

省略可。このインスタンスのアップグレード前の VM イメージ。
containerImage

string

省略可。このインスタンスのアップグレード前のコンテナ イメージ。
framework

string

省略可。このノートブック インスタンスのフレームワーク。
version

string

省略可。このアップグレード前のノートブック インスタンスのバージョン。
state

enum (State)

出力専用。このインスタンス アップグレード履歴エントリの状態。
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"。
action

enum (Action)

省略可。アクション:ロールバックまたはアップグレード。
targetVersion

string

省略可。ターゲット VM のバージョン（m63 など）。

状態

このアップグレード履歴エントリの状態の定義。

列挙型
STATE_UNSPECIFIED 状態が指定されていません。
STARTED インスタンスのアップグレードが開始されます。
SUCCEEDED インスタンスのアップグレードが成功しました。
FAILED インスタンスのアップグレードが失敗しました。

アクション

このアップグレード履歴エントリのオペレーションの定義。

列挙型
ACTION_UNSPECIFIED オペレーションが指定されていません。
UPGRADE アップグレードしてください。
ROLLBACK Rollback のインスタンスを発生させることができます。

HealthState

インスタンスの健全性。

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

メソッド

checkUpgradability

 ノートブック インスタンスがアップグレード可能かどうかを確認します。

create

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

delete

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

diagnose

 インスタンスを指定して診断ファイルを作成し、診断ツールを実行します。

get

 1 つのインスタンスの詳細を取得します。

getConfig

 さまざまな構成パラメータを返します。

getIamPolicy

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

list

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

patch

 UpdateInstance はインスタンスを更新します。

reset

 ノートブック インスタンスをリセットします。

resizeDisk

 ノートブック インスタンスのディスクの容量を増やします。

restore

 RestoreInstance は、BackupSource からインスタンスを復元します。

rollback

 ノートブック インスタンスを以前のバージョンにロールバックします。

setIamPolicy

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

start

 ノートブック インスタンスを起動します。

stop

 ノートブック インスタンスを停止します。

testIamPermissions

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

upgrade

 ノートブック インスタンスを最新バージョンにアップグレードします。