このページの一部またはすべての情報は、S3NS の Cloud de Confiance に適用されない場合があります。詳細については、Google Cloud との違いをご確認ください。

Google は AI 技術を使用して、コンテンツをご希望の言語に翻訳しています。AI 翻訳には誤りが含まれる場合があります。

REST Resource: projects.locations.instances

リソース: インスタンス

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

JSON 表現

JSON 表現
{ "name": string, "postStartupScript": string, "proxyUri": string, "instanceOwners": [ string ], "serviceAccount": string, "serviceAccountScopes": [ string ], "machineType": string, "acceleratorConfig": { object (`AcceleratorConfig`) }, "state": enum (`State`), "installGpuDriver": boolean, "customGpuDriverPath": string, "bootDiskType": enum (`DiskType`), "bootDiskSizeGb": string, "dataDiskType": enum (`DiskType`), "dataDiskSizeGb": string, "noRemoveDataDisk": boolean, "diskEncryption": enum (`DiskEncryption`), "kmsKey": string, "disks": [ { object (`Disk`) } ], "shieldedInstanceConfig": { object (`ShieldedInstanceConfig`) }, "noPublicIp": boolean, "noProxyAccess": boolean, "network": string, "subnet": string, "labels": { string: string, ... }, "metadata": { string: string, ... }, "tags": [ string ], "upgradeHistory": [ { object (`UpgradeHistoryEntry`) } ], "nicType": enum (`NicType`), "reservationAffinity": { object (`ReservationAffinity`) }, "creator": string, "canIpForward": boolean, "createTime": string, "updateTime": string, "instanceMigrationEligibility": { object (`InstanceMigrationEligibility`) }, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "vmImage": { object (`VmImage`) }, "containerImage": { object (`ContainerImage`) } // End of mutually exclusive fields. "migrated": boolean }

{
  "name": string,
  "postStartupScript": string,
  "proxyUri": string,
  "instanceOwners": [
    string
  ],
  "serviceAccount": string,
  "serviceAccountScopes": [
    string
  ],
  "machineType": string,
  "acceleratorConfig": {
    object (AcceleratorConfig)
  },
  "state": enum (State),
  "installGpuDriver": boolean,
  "customGpuDriverPath": string,
  "bootDiskType": enum (DiskType),
  "bootDiskSizeGb": string,
  "dataDiskType": enum (DiskType),
  "dataDiskSizeGb": string,
  "noRemoveDataDisk": boolean,
  "diskEncryption": enum (DiskEncryption),
  "kmsKey": string,
  "disks": [
    {
      object (Disk)
    }
  ],
  "shieldedInstanceConfig": {
    object (ShieldedInstanceConfig)
  },
  "noPublicIp": boolean,
  "noProxyAccess": boolean,
  "network": string,
  "subnet": string,
  "labels": {
    string: string,
    ...
  },
  "metadata": {
    string: string,
    ...
  },
  "tags": [
    string
  ],
  "upgradeHistory": [
    {
      object (UpgradeHistoryEntry)
    }
  ],
  "nicType": enum (NicType),
  "reservationAffinity": {
    object (ReservationAffinity)
  },
  "creator": string,
  "canIpForward": boolean,
  "createTime": string,
  "updateTime": string,
  "instanceMigrationEligibility": {
    object (InstanceMigrationEligibility)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "vmImage": {
    object (VmImage)
  },
  "containerImage": {
    object (ContainerImage)
  }
  // End of mutually exclusive fields.
  "migrated": boolean
}

フィールド
`name`	`string` 出力専用。このノートブックインスタンスの名前。形式: `projects/{projectId}/locations/{location}/instances/{instanceId}`
`postStartupScript`	`string` ノートブックインスタンスが完全に起動した後に自動的に実行される Bash スクリプトのパス。パスは、URL または Cloud Storage パス（`gs://path-to-file/file-name`）にする必要があります。
`proxyUri`	`string` 出力専用。Jupyter ノートブックへのアクセスに使用されるプロキシエンドポイント。
`instanceOwners[]`	`string` 入力専用。作成後のこのインスタンスのオーナー。形式: `alias@example.com` 現在、サポートされているオーナーは 1 人のみです。指定しない場合、VM インスタンスのサービスアカウントのすべてのサービスアカウントユーザーがインスタンスを使用できます。
`serviceAccount`	`string` このインスタンスのサービスアカウント。他の Google Cloud サービスへのアクセス権が付与されます。同じプロジェクト内ではどのサービスアカウントでも使用できますが、インスタンスを使用するには、サービスアカウントユーザー権限が必要です。指定しない場合は、Compute Engine のデフォルトサービスアカウントが使用されます。
`serviceAccountScopes[]`	`string` 省略可。Compute Engine インスタンスに含めるサービスアカウントスコープの URI。指定しない場合は、次のスコープが定義されます。- https://www.googleapis.com/auth/cloud-platform- https://www.googleapis.com/auth/userinfo.emailデフォルトのスコープを使用しない場合は、少なくとも https://www.googleapis.com/auth/compute が必要です。
`machineType`	`string` 必須。このインスタンスの Compute Engine マシンタイプ。
`acceleratorConfig`	`object (AcceleratorConfig)` このインスタンスで使用されるハードウェアアクセラレータ。アクセラレータを使用する場合は、選択した `machineType` をサポートするのに十分な vCPU とメモリが構成に含まれていることを確認してください。
`state`	`enum (State)` 出力専用。このインスタンスの状態。
`installGpuDriver`	`boolean` エンドユーザーが Google Cloud にこのインスタンスへの GPU ドライバのインストールを承認するかどうか。このフィールドが空の場合、または false に設定されている場合、GPU ドライバはインストールされません。GPU を使用するインスタンスにのみ適用されます。
`customGpuDriverPath`	`string` GPU ドライバが保存されているカスタム Cloud Storage パスを指定します。指定しない場合、公式の GPU ドライバから自動的に選択されます。
`bootDiskType`	`enum (DiskType)` 入力専用。このインスタンスにアタッチされているブートディスクのタイプ。デフォルトは標準永続ディスク（`PD_STANDARD`）です。
`bootDiskSizeGb`	`string (int64 format)` 入力専用。このインスタンスにアタッチされているブートディスクのサイズ（GB）。最大 64, 000 GB（64 TB）。推奨される最小値は 100 GB です。指定しない場合、デフォルトは 100 です。
`dataDiskType`	`enum (DiskType)` 入力専用。このインスタンスにアタッチされているデータディスクのタイプ。デフォルトは標準永続ディスク（`PD_STANDARD`）です。
`dataDiskSizeGb`	`string (int64 format)` 入力専用。このインスタンスにアタッチされているデータディスクのサイズ（GB 単位）。最大 64, 000 GB（64 TB）。ノートブックとデータのサイズに基づいて、データディスクのサイズを選択できます。指定しない場合、デフォルトは 100 です。
`noRemoveDataDisk`	`boolean` 入力専用。true の場合、インスタンスを削除してもデータディスクは自動的に削除されません。
`diskEncryption`	`enum (DiskEncryption)` 入力専用。ブートディスクとデータディスクで使用されるディスク暗号化方式。デフォルトは GMEK です。
`kmsKey`	`string` 入力専用。ディスクの暗号化に使用される KMS 鍵。diskEncryption が CMEK の場合にのみ適用されます。形式: `projects/{projectId}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` 詳細については、独自の暗号鍵の使用をご覧ください。
`disks[]`	`object (Disk)` 出力専用。ノートブックインスタンスにアタッチされたディスク。
`shieldedInstanceConfig`	`object (ShieldedInstanceConfig)` 省略可。Shielded VM の構成。サポートされている Shielded VM 機能を使用するイメージ。
`noPublicIp`	`boolean` true の場合、このインスタンスに外部 IP は割り当てられません。
`noProxyAccess`	`boolean` true の場合、ノートブックインスタンスはプロキシに登録されません。
`network`	`string` このインスタンスが存在する VPC の名前。形式: `projects/{projectId}/global/networks/{network_id}`
`subnet`	`string` このインスタンスが存在するサブネットの名前。形式: `projects/{projectId}/regions/{region}/subnetworks/{subnetwork_id}`
`labels`	`map (key: string, value: string)` このインスタンスに適用するラベル。これらは、setLabels メソッドで後から変更できます。 `"key": value` ペアのリストを含むオブジェクト。例: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`
`metadata`	`map (key: string, value: string)` このインスタンスに適用するカスタムメタデータ。たとえば、自動バックアップ用の Cloud Storage バケットを指定するには、`gcs-data-bucket` メタデータタグを使用できます。形式: `"--metadata=gcs-data-bucket=BUCKET"`。 `"key": value` ペアのリストを含むオブジェクト。例: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`
`tags[]`	`string` 省略可。ランタイムに追加する Compute Engine ネットワークタグ（ネットワークタグを追加するをご覧ください）。
`upgradeHistory[]`	`object (UpgradeHistoryEntry)` このインスタンスのアップグレード履歴。
`nicType`	`enum (NicType)` 省略可。このインターフェースで使用する vNIC のタイプ。gVNIC または VirtioNet のいずれかになります。
`reservationAffinity`	`object (ReservationAffinity)` 省略可。省略可能な予約アフィニティ。このフィールドを設定すると、指定されたゾーンコンピューティング予約がこのノートブックインスタンスに適用されます。
`creator`	`string` 出力専用。元の instances.create リクエストを送信したエンティティのメールアドレス。
`canIpForward`	`boolean` 省略可。IP 転送を有効にするかどうかを示すフラグ。デフォルトは false（オフ）です。https://cloud.google.com/vpc/docs/using-routes#canipforward
`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"`。
`instanceMigrationEligibility`	`object (InstanceMigrationEligibility)` 出力専用。UmN から WbI への移行の実現可能性を確認します。
環境のタイプ。VM イメージまたはコンテナイメージのいずれかになります。以下は、相互に排他的なフィールドのリストです。レスポンスに設定されるフィールドは、最大 1 つです。
`vmImage`	`object (VmImage)` Compute Engine VM イメージを使用してノートブックインスタンスを起動します。
`containerImage`	`object (ContainerImage)` コンテナイメージを使用してノートブックインスタンスを起動します。
相互に排他的なフィールドの終わり。
`migrated`	`boolean` 出力専用。このノートブックが Workbench インスタンスに移行されたかどうかを示すブール値

AcceleratorConfig

ハードウェアアクセラレータの定義。type と coreCount のすべての組み合わせが有効であるわけではありません。有効な組み合わせについては、Compute Engine の GPU をご覧ください。TPU はサポートされていません。

JSON 表現
{ "type": enum (`AcceleratorType`), "coreCount": string }

フィールド

フィールド
`type`	`enum (AcceleratorType)` このアクセラレータのタイプ。
`coreCount`	`string (int64 format)` このアクセラレータのコア数。

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 です。
`NVIDIA_L4`	アクセラレータタイプは Nvidia Tesla L4 です。
`NVIDIA_A100_80GB`	アクセラレータタイプは Nvidia Tesla A100 80 GB です。
`NVIDIA_TESLA_T4_VWS`	アクセラレータタイプは NVIDIA Tesla T4 仮想ワークステーションです。
`NVIDIA_TESLA_P100_VWS`	アクセラレータタイプは NVIDIA Tesla P100 仮想ワークステーションです。
`NVIDIA_TESLA_P4_VWS`	アクセラレータタイプは NVIDIA Tesla P4 仮想ワークステーションです。
`NVIDIA_H100_80GB`	アクセラレータタイプは NVIDIA H100 80 GB です。
`NVIDIA_H100_MEGA_80GB`	アクセラレータタイプは NVIDIA H100 Mega 80 GB です。
`TPU_V2`	（近日公開）アクセラレータタイプは TPU V2 です。
`TPU_V3`	（近日公開）アクセラレータタイプは TPU V3 です。

状態

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

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

DiskType

ノートブックインスタンスで使用できるディスクタイプ。

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

DiskEncryption

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

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

ディスク

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

JSON 表現

JSON 表現
{ "autoDelete": boolean, "boot": boolean, "deviceName": string, "diskSizeGb": string, "guestOsFeatures": [ { object (`GuestOsFeature`) } ], "index": string, "interface": string, "kind": string, "licenses": [ string ], "mode": string, "source": string, "type": string }

{
  "autoDelete": boolean,
  "boot": boolean,
  "deviceName": string,
  "diskSizeGb": string,
  "guestOsFeatures": [
    {
      object (GuestOsFeature)
    }
  ],
  "index": string,
  "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 により割り当てられた番号です。このフィールドは Persistent Disk にのみ適用されます。
`diskSizeGb`	`string (int64 format)` ディスクのサイズを 2 進数の GB 単位で示します。
`guestOsFeatures[]`	`object (GuestOsFeature)` ゲストオペレーティングシステムで有効にする機能のリストを示します。ブート可能なイメージにのみ適用されます。使用可能なオプションの一覧については、ゲストオペレーティングシステムの機能を有効にするをご覧ください。
`index`	`string (int64 format)` このディスクの 0 から始まるインデックス。0 はブートディスク用に予約されています。インスタンスに複数のディスクがアタッチされている場合、各ディスクには一意のインデックス番号が割り当てられます。
`interface`	`string` このディスクのアタッチに使用するディスクインターフェース（SCSI または NVME）を示します。デフォルトは SCSI です。永続ディスクは常に SCSI を使用する必要があります。SCSI 以外の形式で永続ディスクをアタッチしようとすると、リクエストは失敗します。ローカル SSD は NVMe または SCSI のいずれかを使用できます。NVMe 経由の SCSI のパフォーマンス特性については、ローカル SSD のパフォーマンスをご覧ください。有効な値: `NVME` `SCSI`
`kind`	`string` リソースのタイプ。アタッチされたディスクの compute#attachedDisk を常に計算します。
`licenses[]`	`string` 一般公開されているライセンスのリスト。Google で使用するために予約されています。ライセンスは、パブリックイメージと Marketplace イメージの課金データと使用状況の集計データを表します。
`mode`	`string` このディスクをアタッチするモード（`READ_WRITE` または `READ_ONLY`）。指定しない場合、デフォルトではディスクは `READ_WRITE` モードでアタッチされます。有効な値: `READ_ONLY` `READ_WRITE`
`source`	`string` 既存の Persistent Disk リソースへの有効な部分 URL または完全 URL を示します。
`type`	`string` ディスクのタイプ（`SCRATCH` または `PERSISTENT`）を示します。有効な値: `PERSISTENT` `SCRATCH`

GuestOsFeature

ブートディスクのゲスト OS の機能。

JSON 表現
{ "type": string }

フィールド

フィールド
`type`	`string` サポートされている機能の ID。使用可能なオプションの一覧については、ゲストオペレーティングシステムの機能を有効にするをご覧ください。有効な値: `FEATURE_TYPE_UNSPECIFIED` `MULTI_IP_SUBNET` `SECURE_BOOT` `UEFI_COMPATIBLE` `VIRTIO_SCSI_MULTIQUEUE` `WINDOWS`

type

string

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

FEATURE_TYPE_UNSPECIFIED
MULTI_IP_SUBNET
SECURE_BOOT
UEFI_COMPATIBLE
VIRTIO_SCSI_MULTIQUEUE
WINDOWS

ShieldedInstanceConfig

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

JSON 表現
{ "enableSecureBoot": boolean, "enableVtpm": boolean, "enableIntegrityMonitoring": boolean }

フィールド

フィールド
`enableSecureBoot`	`boolean` インスタンスでセキュアブートを有効にするかどうかを定義します。セキュアブートは、すべてのブートコンポーネントのデジタル署名を検証し、署名検証が失敗した場合にブートプロセスを停止することで、システムで正規のソフトウェアのみが実行されるようにします。デフォルトでは無効にされています。
`enableVtpm`	`boolean` インスタンスで vTPM が有効になっているかどうかを定義します。デフォルトで有効になっています。
`enableIntegrityMonitoring`	`boolean` インスタンスで整合性モニタリングを有効にするかどうかを定義します。インスタンスの起動時の整合性のモニタリングと証明書取得を有効にします。構成証明は、整合性ポリシーベースラインに対して実行されます。このベースラインは、インスタンスの作成時に、暗黙的に信頼されているブートイメージから派生します。デフォルトで有効になっています。

enableSecureBoot

boolean

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

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

enableVtpm

boolean

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

enableIntegrityMonitoring

boolean

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

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

UpgradeHistoryEntry

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

JSON 表現

JSON 表現
{ "snapshot": string, "vmImage": string, "containerImage": string, "framework": string, "version": string, "state": enum (`State`), "createTime": string, "targetImage": string, "action": enum (`Action`), "targetVersion": string }

{
  "snapshot": string,
  "vmImage": string,
  "containerImage": string,
  "framework": string,
  "version": string,
  "state": enum (State),
  "createTime": string,
  "targetImage": 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"`。
`targetImage (deprecated)`	`string` この項目は非推奨です。ターゲット VM イメージ。形式: `ainotebooks-vm/project/image-name/name`。
`action`	`enum (Action)` アクション:ロールバックまたはアップグレード。
`targetVersion`	`string` ターゲット VM バージョン（m63 など）。

状態

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

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

アクション

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

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

NicType

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

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

ReservationAffinity

ゾーン予約を使用するための予約アフィニティ。

JSON 表現
{ "consumeReservationType": enum (`Type`), "key": string, "values": [ string ] }

フィールド

フィールド
`consumeReservationType`	`enum (Type)` 省略可。使用する予約のタイプ
`key`	`string` 省略可。予約リソースのラベルキーに対応します。
`values[]`	`string` 省略可。予約リソースのラベル値に対応します。

consumeReservationType

enum (Type)

省略可。使用する予約のタイプ

key

string

省略可。予約リソースのラベルキーに対応します。

values[]

string

省略可。予約リソースのラベル値に対応します。

タイプ

予約から容量を消費するかどうかを示します。

列挙型
`TYPE_UNSPECIFIED`	デフォルトのタイプ。
`NO_RESERVATION`	割り当てられた容量を使用しない。
`ANY_RESERVATION`	利用可能な予約を使用します。
`SPECIFIC_RESERVATION`	特定の予約から使用する必要があります。予約を指定するためのキー値フィールドを指定する必要があります。

InstanceMigrationEligibility

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

JSON 表現
{ "warnings": [ enum (`Warning`) ], "errors": [ enum (`Error`) ] }

フィールド

フィールド
`warnings[]`	`enum (Warning)` 出力専用。移行時に、特定の構成はデフォルト設定になります。
`errors[]`	`enum (Error)` 出力専用。特定の構成では、UmN は自動移行の対象外になります。手動移行が必要です。

warnings[]

enum (Warning)

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

errors[]

enum (Error)

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

警告

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

列挙型
`WARNING_UNSPECIFIED`	デフォルトのタイプ。
`UNSUPPORTED_MACHINE_TYPE`	UmN で、WbI でサポートされていないマシンタイプが使用されています。デフォルトのマシンタイプ e2-standard-4 で移行されます。移行後にマシンタイプを変更できます。
`UNSUPPORTED_ACCELERATOR_TYPE`	UmN で、WbI でサポートされていないアクセラレータタイプが使用されています。アクセラレータなしで移行されます。アクセラレータは移行後に接続できます。
`UNSUPPORTED_OS`	UmN が WbI でサポートされていないオペレーティングシステム（Debian 10、Ubuntu など）を使用している。WbI では Debian 11 に置き換えられます。
`NO_REMOVE_DATA_DISK`	この UmN は noRemoveDataDisk で構成されていますが、これは WbI では使用できなくなりました。
`GCS_BACKUP`	この UmN は、WbI で利用できなくなった Cloud Storage のバックアップ機能で構成されています。
`POST_STARTUP_SCRIPT`	この UmN は、起動スクリプトで構成されています。必要に応じて、移行の `postStartupScriptOption` を指定してください。

エラー

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

列挙型
`ERROR_UNSPECIFIED`	デフォルトのタイプ。
`DATAPROC_HUB`	UmN は Dataproc Hub を使用しており、移行できません。

メソッド
`create`	指定されたプロジェクトとロケーションで新しいインスタンスを作成します。
`delete`	1 つのインスタンスを削除します。
`diagnose`	インスタンスを指定して診断ファイルを作成し、診断ツールを実行します。
`get`	1 つのインスタンスの詳細を取得します。
`getIamPolicy`	リソースのアクセス制御ポリシーを取得します。
`getInstanceHealth`	ノートブックインスタンスが正常かどうかを確認します。
`isUpgradeable`	ノートブックインスタンスをアップグレードできるかどうかを確認します。
`list`	指定されたプロジェクトとロケーションのインスタンスを一覧表示します。
`migrate`	既存のユーザー管理ノートブックを Workbench インスタンスに移行します。
`register`	既存の以前のノートブックインスタンスを Notebooks API サーバーに登録します。
`report`	ノートブックインスタンスが最新のインスタンス情報を Notebooks API サーバーに報告できるようにします。
`reset`	ノートブックインスタンスをリセットします。
`rollback`	ノートブックインスタンスを以前のバージョンにロールバックします。
`setAccelerator`	単一インスタンスのゲストアクセラレータを更新します。
`setIamPolicy`	指定したリソースにアクセス制御ポリシーを設定します。
`setLabels`	インスタンスのすべてのラベルを置き換えます。
`setMachineType`	単一インスタンスのマシンタイプを更新します。
`start`	ノートブックインスタンスを起動します。
`stop`	ノートブックインスタンスを停止します。
`testIamPermissions`	指定したリソースに対して呼び出し元が持っている権限を返します。
`updateConfig`	ノートブックインスタンスの構成を更新します。
`updateMetadataItems`	インスタンスのメタデータ項目を追加または更新します。
`updateShieldedInstanceConfig`	単一インスタンスのシールドされたインスタンス構成を更新します。
`upgrade`	ノートブックインスタンスを最新バージョンにアップグレードします。

REST Resource: projects.locations.instances

リソース: インスタンス

AcceleratorConfig

AcceleratorType

状態

DiskType

DiskEncryption

ディスク

GuestOsFeature

ShieldedInstanceConfig

UpgradeHistoryEntry

状態

アクション

NicType

ReservationAffinity

タイプ

InstanceMigrationEligibility

警告

エラー

メソッド