Package google.cloud.notebooks.v2

Indeks

NotebookService

Layanan API v2 untuk Instance Notebook Workbench.

CheckInstanceUpgradability

rpc CheckInstanceUpgradability(CheckInstanceUpgradabilityRequest) returns (CheckInstanceUpgradabilityResponse)

Memeriksa apakah instance notebook dapat diupgrade.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
CreateInstance

rpc CreateInstance(CreateInstanceRequest) returns (Operation)

Membuat Instance baru di project dan lokasi tertentu.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
DeleteInstance

rpc DeleteInstance(DeleteInstanceRequest) returns (Operation)

Menghapus satu Instance.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
DiagnoseInstance

rpc DiagnoseInstance(DiagnoseInstanceRequest) returns (Operation)

Membuat File Diagnostik dan menjalankan Alat Diagnostik yang diberikan Instance.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
GetConfig

rpc GetConfig(GetConfigRequest) returns (Config)

Menampilkan berbagai parameter konfigurasi.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
GetInstance

rpc GetInstance(GetInstanceRequest) returns (Instance)

Mendapatkan detail satu Instance.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
ListInstances

rpc ListInstances(ListInstancesRequest) returns (ListInstancesResponse)

Mencantumkan instance dalam project dan lokasi tertentu.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
ResetInstance

rpc ResetInstance(ResetInstanceRequest) returns (Operation)

Mereset instance notebook.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
ResizeDisk

rpc ResizeDisk(ResizeDiskRequest) returns (Operation)

Ubah ukuran disk instance notebook ke kapasitas yang lebih tinggi.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
RestoreInstance

rpc RestoreInstance(RestoreInstanceRequest) returns (Operation)

RestoreInstance memulihkan Instance dari BackupSource.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
RollbackInstance

rpc RollbackInstance(RollbackInstanceRequest) returns (Operation)

Melakukan roll back instance notebook ke versi sebelumnya.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
StartInstance

rpc StartInstance(StartInstanceRequest) returns (Operation)

Memulai instance notebook.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
StopInstance

rpc StopInstance(StopInstanceRequest) returns (Operation)

Menghentikan instance notebook.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
UpdateInstance

rpc UpdateInstance(UpdateInstanceRequest) returns (Operation)

UpdateInstance memperbarui Instance.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
UpgradeInstance

rpc UpgradeInstance(UpgradeInstanceRequest) returns (Operation)

Mengupgrade instance notebook ke versi terbaru.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

AcceleratorConfig

Konfigurasi akselerator untuk instance VM. Definisi akselerator hardware. Perhatikan bahwa tidak ada pemeriksaan pada kombinasi type dan core_count. TPU tidak didukung. Lihat GPU di Compute Engine untuk menemukan kombinasi yang valid.

Kolom
type

AcceleratorType

Opsional. Jenis akselerator ini.
core_count

int64

Opsional. Jumlah inti akselerator ini.

AcceleratorType

Definisi jenis akselerator hardware yang dapat digunakan pada instance ini.

Enum
ACCELERATOR_TYPE_UNSPECIFIED Jenis akselerator tidak ditentukan.
NVIDIA_TESLA_P100 Jenis akselerator adalah Nvidia Tesla P100.
NVIDIA_TESLA_V100 Jenis akselerator adalah Nvidia Tesla V100.
NVIDIA_TESLA_P4 Jenis akselerator adalah Nvidia Tesla P4.
NVIDIA_TESLA_T4 Jenis akselerator adalah Nvidia Tesla T4.
NVIDIA_TESLA_A100 Jenis akseleratornya adalah Nvidia Tesla A100 - 40 GB.
NVIDIA_A100_80GB Jenis akseleratornya adalah Nvidia Tesla A100 - 80 GB.
NVIDIA_L4 Jenis akselerator adalah Nvidia Tesla L4.
NVIDIA_H100_80GB Jenis akseleratornya adalah Nvidia Tesla H100 - 80 GB.
NVIDIA_H100_MEGA_80GB Jenis akselerator adalah Nvidia Tesla H100 - MEGA 80 GB.
NVIDIA_H200_141GB Jenis akseleratornya adalah Nvidia Tesla H200 - 141 GB.
NVIDIA_TESLA_T4_VWS Jenis akselerator adalah NVIDIA Tesla T4 Virtual Workstations.
NVIDIA_TESLA_P100_VWS Jenis akselerator adalah NVIDIA Tesla P100 Virtual Workstations.
NVIDIA_TESLA_P4_VWS Jenis akselerator adalah NVIDIA Tesla P4 Virtual Workstations.
NVIDIA_B200 Jenis akselerator adalah NVIDIA B200.

AccessConfig

Konfigurasi akses yang terpasang ke antarmuka jaringan instance.

Kolom
external_ip

string

Alamat IP eksternal yang dikaitkan dengan instance ini. Tentukan alamat IP eksternal statis yang tidak digunakan dan tersedia untuk project atau biarkan kolom ini tidak ditentukan untuk menggunakan IP dari kumpulan alamat IP sementara yang digunakan bersama. Jika Anda menentukan alamat IP eksternal statis, alamat tersebut harus berada di region yang sama dengan zona instance.

BootDisk

Definisi boot disk.

Kolom
disk_size_gb

int64

Opsional. Ukuran boot disk dalam GB yang terpasang ke instance ini, hingga maksimum 64000 GB (64 TB). Jika tidak ditentukan, nilai ini akan ditetapkan secara default ke nilai yang direkomendasikan, yaitu 150 GB.
disk_type

DiskType

Opsional. Menunjukkan jenis disk.
disk_encryption

DiskEncryption

Opsional. Hanya input. Metode enkripsi disk yang digunakan pada boot disk dan disk data, defaultnya adalah GMEK.
kms_key

string

Opsional. Hanya input. Kunci KMS yang digunakan untuk mengenkripsi disk, hanya berlaku jika disk_encryption adalah CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

Pelajari lebih lanjut cara menggunakan kunci enkripsi Anda sendiri.

CheckInstanceUpgradabilityRequest

Permintaan untuk memeriksa apakah instance notebook dapat diupgrade.

Kolom
notebook_instance

string

Wajib. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Otorisasi memerlukan izin IAM berikut pada notebookInstance resource yang ditentukan:

  • notebooks.instances.checkUpgradability

CheckInstanceUpgradabilityResponse

Respons untuk memeriksa apakah instance notebook dapat diupgrade.

Kolom
upgradeable

bool

Jika instance dapat diupgrade.
upgrade_version

string

Versi yang akan diupgrade instance ini jika memanggil endpoint upgrade. Kolom ini hanya akan diisi jika field upgradeable bernilai benar (true).
upgrade_info

string

Informasi tambahan tentang upgrade.
upgrade_image

string

Link mandiri gambar baru yang akan diupgrade instance ini jika memanggil endpoint upgrade. Kolom ini hanya akan diisi jika field upgradeable bernilai benar (true).

ConfidentialInstanceConfig

Serangkaian opsi Instance Rahasia.

Kolom
confidential_instance_type

ConfidentialInstanceType

Opsional. Menentukan jenis teknologi yang digunakan oleh instance rahasia.

ConfidentialInstanceType

Jenis instance rahasia.

Enum
CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED Tidak ada jenis yang ditentukan. Jangan gunakan nilai ini.
SEV AMD Secure Encrypted Virtualization.

Konfigurasi

Respons untuk mendapatkan konfigurasi WbI di lokasi

Kolom
default_values

DefaultValues

Hanya output. Nilai default untuk konfigurasi.
supported_values

SupportedValues

Hanya output. Nilai yang didukung untuk konfigurasi.
available_images[]

ImageRelease

Hanya output. Daftar gambar yang tersedia untuk membuat WbI.
disable_workbench_legacy_creation

bool

Hanya output. Flag untuk menonaktifkan pembuatan notebook Workbench lama (Notebook yang dikelola pengguna dan notebook yang dikelola Google).

ContainerImage

Definisi image container untuk memulai instance notebook dengan lingkungan yang diinstal dalam container.

Kolom
repository

string

Wajib. Jalur ke repositori image container. Contoh: gcr.io/{project_id}/{image_name}
tag

string

Opsional. Tag image container. Jika tidak ditentukan, defaultnya adalah tag terbaru.

CreateInstanceRequest

Permintaan untuk membuat instance notebook.

Kolom
parent

string

Wajib. Format: parent=projects/{project_id}/locations/{location}

Otorisasi memerlukan izin IAM berikut pada parent resource yang ditentukan:

  • notebooks.instances.create
instance_id

string

Wajib. ID unik yang ditentukan pengguna untuk instance ini.
instance

Instance

Wajib. Instance yang akan dibuat.
request_id

string

Opsional. UUID permintaan idempoten.

DataDisk

Resource disk yang terpasang ke instance.

Kolom
disk_size_gb

int64

Opsional. Ukuran disk dalam GB yang terpasang ke instance VM ini, hingga maksimum 64000 GB (64 TB). Jika tidak ditentukan, nilai defaultnya adalah 100.
disk_type

DiskType

Opsional. Hanya input. Menunjukkan jenis disk.
disk_encryption

DiskEncryption

Opsional. Hanya input. Metode enkripsi disk yang digunakan pada boot disk dan disk data, defaultnya adalah GMEK.
kms_key

string

Opsional. Hanya input. Kunci KMS yang digunakan untuk mengenkripsi disk, hanya berlaku jika disk_encryption adalah CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

Pelajari lebih lanjut cara menggunakan kunci enkripsi Anda sendiri.
resource_policies[]

string

Opsional. Kebijakan resource yang akan diterapkan ke disk data.

DefaultValues

DefaultValues merepresentasikan nilai konfigurasi default.

Kolom
machine_type

string

Hanya output. Jenis mesin default yang digunakan oleh backend jika tidak disediakan oleh pengguna.

DeleteInstanceRequest

Permintaan untuk menghapus instance notebook.

Kolom
name

string

Wajib. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Otorisasi memerlukan izin IAM berikut pada name resource yang ditentukan:

  • notebooks.instances.delete
request_id

string

Opsional. UUID permintaan idempoten.

DiagnoseInstanceRequest

Permintaan untuk membuat file diagnostik instance notebook.

Kolom
name

string

Wajib. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Otorisasi memerlukan izin IAM berikut pada name resource yang ditentukan:

  • notebooks.instances.diagnose
diagnostic_config

DiagnosticConfig

Wajib. Menentukan flag yang digunakan untuk menjalankan alat diagnostik
timeout_minutes

int32

Opsional. Jumlah waktu maksimum dalam menit sebelum operasi kehabisan waktu.

DiagnosticConfig

Menentukan flag yang digunakan untuk menjalankan alat diagnostik

Kolom
gcs_bucket

string

Wajib. Lokasi bucket Cloud Storage pengguna (WAJIB). Harus diformat dengan awalan jalur (gs://$GCS_BUCKET).

Izin: Notebook yang Dikelola Pengguna: - storage.buckets.writer: Harus diberikan ke akun layanan project yang terlampir ke VM. Google Managed Notebooks: - storage.buckets.writer: Harus diberikan ke akun layanan project atau kredensial pengguna yang terlampir ke VM, bergantung pada mode autentikasi.

File Log bucket Cloud Storage akan ditulis ke gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
relative_path

string

Opsional. Menentukan jalur penyimpanan relatif di bucket Cloud Storage tempat log diagnostik akan ditulis: Jalur default adalah direktori root bucket Cloud Storage (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz) Contoh jalur lengkap tempat file Log akan ditulis: gs://$GCS_BUCKET/$RELATIVE_PATH/
enable_repair_flag

bool

Opsional. Mengaktifkan tanda untuk memperbaiki layanan untuk instance
enable_packet_capture_flag

bool

Opsional. Mengaktifkan tanda untuk mengambil paket dari instance selama 30 detik
enable_copy_home_files_flag

bool

Opsional. Mengaktifkan tanda untuk menyalin semua konten folder /home/jupyter

DiskEncryption

Definisi opsi enkripsi disk.

Enum
DISK_ENCRYPTION_UNSPECIFIED Enkripsi disk tidak ditentukan.
GMEK Gunakan kunci enkripsi yang dikelola Google untuk mengenkripsi disk boot.
CMEK Gunakan kunci enkripsi yang dikelola pelanggan untuk mengenkripsi boot disk.

DiskType

Kemungkinan jenis disk.

Enum
DISK_TYPE_UNSPECIFIED Jenis disk belum ditetapkan.
PD_STANDARD Jenis persistent disk standar.
PD_SSD Jenis persistent disk SSD.
PD_BALANCED Jenis persistent disk seimbang.
PD_EXTREME Jenis persistent disk ekstrem.
HYPERDISK_BALANCED Mewakili jenis persistent disk Hyperdisk Balanced. Dapat digunakan sebagai boot disk atau disk data.
HYPERDISK_EXTREME Mewakili jenis persistent disk Hyperdisk Extreme. Hanya dapat digunakan sebagai disk data.
HYPERDISK_THROUGHPUT Menunjukkan jenis persistent disk Hyperdisk Throughput. Hanya dapat digunakan sebagai disk data.
HYPERDISK_BALANCED_HIGH_AVAILABILITY Mewakili jenis persistent disk Hyperdisk Balanced High Availability. Dapat digunakan sebagai boot disk atau disk data.
HYPERDISK_ML Mewakili jenis persistent disk Hyperdisk ML. Dapat digunakan sebagai boot disk atau disk data.

GPUDriverConfig

Konfigurasi driver GPU

Kolom
enable_gpu_driver

bool

Opsional. Apakah pengguna akhir mengizinkan Google Cloud menginstal driver GPU di instance VM ini. Jika kolom ini kosong atau disetel ke salah (false), driver GPU tidak akan diinstal. Hanya berlaku untuk instance dengan GPU.
custom_gpu_driver_path

string

Opsional. Tentukan jalur Cloud Storage kustom tempat driver GPU disimpan. Jika tidak ditentukan, kami akan otomatis memilih dari driver GPU resmi.

GceSetup

Definisi cara mengonfigurasi instance VM di luar Resources and Identity.

Kolom
machine_type

string

Opsional. Jenis mesin instance VM. https://cloud.google.com/compute/docs/machine-resource
min_cpu_platform

string

Opsional. Platform CPU minimum yang akan digunakan untuk instance ini. Daftar nilai yang valid dapat ditemukan di https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform#availablezones
accelerator_configs[]

AcceleratorConfig

Opsional. Akselerator hardware yang digunakan pada instance ini. Jika Anda menggunakan akselerator, pastikan konfigurasi Anda memiliki vCPU dan memori yang cukup untuk mendukung machine_type yang telah Anda pilih. Saat ini hanya mendukung satu konfigurasi akselerator.
service_accounts[]

ServiceAccount

Opsional. Akun layanan yang berfungsi sebagai identitas untuk instance VM. Saat ini hanya mendukung satu akun layanan.
boot_disk

BootDisk

Opsional. Boot disk untuk VM.
data_disks[]

DataDisk

Opsional. Disk data yang terpasang ke instance VM. Saat ini hanya mendukung satu disk data.
shielded_instance_config

ShieldedInstanceConfig

Opsional. Konfigurasi Shielded VM. Image yang menggunakan fitur Shielded VM yang didukung.
network_interfaces[]

NetworkInterface

Opsional. Antarmuka jaringan untuk VM. Hanya mendukung satu antarmuka.
disable_public_ip

bool

Opsional. Jika benar (true), tidak ada IP eksternal yang akan ditetapkan ke instance VM ini.
tags[]

string

Opsional. Tag jaringan Compute Engine yang akan ditambahkan ke runtime (lihat Menambahkan tag jaringan).
metadata

map<string, string>

Opsional. Metadata kustom yang akan diterapkan ke instance ini.
enable_ip_forwarding

bool

Opsional. Flag untuk mengaktifkan penerusan IP atau tidak, defaultnya salah/nonaktif. https://cloud.google.com/vpc/docs/using-routes#canipforward
gpu_driver_config

GPUDriverConfig

Opsional. Konfigurasi untuk driver GPU.
confidential_instance_config

ConfidentialInstanceConfig

Opsional. Konfigurasi instance rahasia.
instance_id

string

Hanya output. ID unik resource instance Compute Engine.
Kolom union image. Jenis image; dapat berupa salah satu dari image VM atau image container. image hanya ada berupa salah satu diantara berikut:
vm_image

VmImage

Opsional. Gunakan image VM Compute Engine untuk memulai instance notebook.
container_image

ContainerImage

Opsional. Gunakan image container untuk memulai instance notebook.

GetConfigRequest

Permintaan untuk mendapatkan parameter konfigurasi Workbench.

Kolom
name

string

Wajib. Format: projects/{project_id}/locations/{location}

GetInstanceRequest

Permintaan untuk mendapatkan instance notebook.

Kolom
name

string

Wajib. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Otorisasi memerlukan izin IAM berikut pada name resource yang ditentukan:

  • notebooks.instances.get

HealthState

Status respons instance.

Enum
HEALTH_STATE_UNSPECIFIED Substatus instance tidak diketahui.
HEALTHY Instance diketahui dalam kondisi baik (misalnya, daemon penting sedang berjalan). Berlaku untuk status AKTIF.
UNHEALTHY Instance diketahui dalam kondisi tidak sehat (misalnya, daemon penting tidak berjalan). Berlaku untuk status AKTIF.
AGENT_NOT_INSTALLED Instance belum menginstal agen pemantauan kondisi. Berlaku untuk status AKTIF.
AGENT_NOT_RUNNING Agen pemantauan kondisi instance tidak berjalan. Berlaku untuk status AKTIF.

ImageRelease

ConfigImage mewakili rilis image yang tersedia untuk membuat WbI

Kolom
image_name

string

Hanya output. Nama image dalam bentuk workbench-instances-vYYYYmmdd--
release_name

string

Hanya output. Rilis gambar formulir m123

Instance

Definisi instance notebook.

Kolom
name

string

Hanya output. ID. Nama instance notebook ini. Format: projects/{project_id}/locations/{location}/instances/{instance_id}
proxy_uri

string

Hanya output. Endpoint proxy yang digunakan untuk mengakses notebook Jupyter.
instance_owners[]

string

Opsional. Pemilik instance ini setelah dibuat. Format: alias@example.com

Saat ini hanya mendukung satu pemilik. Jika tidak ditentukan, semua pengguna akun layanan dari akun layanan instance VM Anda dapat menggunakan instance tersebut.
creator

string

Hanya output. Alamat email entitas yang mengirim permintaan CreateInstance asli.
state

State

Hanya output. Status instance ini.
upgrade_history[]

UpgradeHistoryEntry

Hanya output. Histori upgrade instance ini.
id

string

Hanya output. ID unik resource.
health_state

HealthState

Hanya output. Instance health_state.
health_info

map<string, string>

Hanya output. Informasi tambahan tentang kondisi instance. Contoh:

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

Timestamp

Hanya output. Waktu pembuatan instance.
update_time

Timestamp

Hanya output. Waktu update instance.
disable_proxy_access

bool

Opsional. Jika benar, instance notebook tidak akan didaftarkan ke proxy.
labels

map<string, string>

Opsional. Label yang akan diterapkan ke instance ini. Nilai ini dapat diubah nanti dengan metode UpdateInstance.
third_party_proxy_url

string

Hanya output. Endpoint proxy kumpulan tenaga kerja yang digunakan untuk mengakses notebook Jupyter.
satisfies_pzs

bool

Hanya output. Dicadangkan untuk penggunaan mendatang untuk Pemisahan Zona.
satisfies_pzi

bool

Hanya output. Dicadangkan untuk penggunaan mendatang untuk Isolasi Zona.
enable_third_party_identity

bool

Opsional. Tanda yang menentukan bahwa notebook dapat diakses dengan penyedia identitas pihak ketiga.
enable_managed_euc

bool

Opsional. Flag untuk mengaktifkan kredensial pengguna akhir terkelola untuk instance.
enable_deletion_protection

bool

Opsional. Jika benar (true), perlindungan penghapusan akan diaktifkan untuk Instance Workbench ini. Jika salah (false), perlindungan penghapusan akan dinonaktifkan untuk Instance Workbench ini.
Kolom union infrastructure. Penyiapan untuk instance Notebook. infrastructure hanya ada berupa salah satu diantara berikut:
gce_setup

GceSetup

Opsional. Penyiapan Compute Engine untuk notebook. Menggunakan kolom yang ditentukan notebook.

ListInstancesRequest

Permintaan untuk mencantumkan instance notebook.

Kolom
parent

string

Wajib. Induk instance. Format: - projects/{project_id}/locations/{location} untuk mencantumkan instance di zona tertentu. - projects/{project_id}/locations/- untuk mencantumkan instance di semua lokasi.

Otorisasi memerlukan izin IAM berikut pada parent resource yang ditentukan:

  • notebooks.instances.list
page_size

int32

Opsional. Ukuran maksimum yang ditampilkan dari panggilan daftar.
page_token

string

Opsional. Token halaman yang ditampilkan sebelumnya yang dapat digunakan untuk melanjutkan listingan dari hasil terakhir.
order_by

string

Opsional. Urutkan hasil. Nilai yang didukung adalah "name", "name desc", atau "" (tidak diurutkan).
filter

string

Opsional. Filter daftar.

ListInstancesResponse

Respons untuk mencantumkan instance notebook.

Kolom
instances[]

Instance

Daftar instance yang ditampilkan.
next_page_token

string

Token halaman yang dapat digunakan untuk melanjutkan pencantuman dari hasil terakhir dalam panggilan daftar berikutnya.
unreachable[]

string

Daftar yang tidak diurutkan. Lokasi yang tidak dapat dijangkau. Misalnya, ['projects/{project_id}/locations/us-west1-a', 'projects/{project_id}/locations/us-central1-b']. ListInstancesResponse hanya akan berisi instance atau unreachables,

NetworkInterface

Definisi resource antarmuka jaringan yang terpasang ke VM.

Kolom
network

string

Opsional. Nama VPC tempat instance VM ini berada. Format: projects/{project_id}/global/networks/{network_id}
subnet

string

Opsional. Nama subnet tempat instance VM ini berada. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
nic_type

NicType

Opsional. Jenis vNIC yang akan digunakan pada antarmuka ini. Ini dapat berupa gVNIC atau VirtioNet.
access_configs[]

AccessConfig

Opsional. Array konfigurasi untuk antarmuka ini. Saat ini, hanya satu konfigurasi akses, ONE_TO_ONE_NAT, yang didukung. Jika tidak ada accessConfigs yang ditentukan, instance akan memiliki akses internet eksternal melalui alamat IP eksternal sementara.

NicType

Jenis driver vNIC. Defaultnya harus NIC_TYPE_UNSPECIFIED.

Enum
NIC_TYPE_UNSPECIFIED Tidak ada jenis yang ditentukan.
VIRTIO_NET VIRTIO
GVNIC GVNIC

OperationMetadata

Mewakili metadata operasi yang berjalan lama.

Kolom
create_time

Timestamp

Waktu pembuatan operasi.
end_time

Timestamp

Waktu selesainya operasi.
target

string

Jalur resource yang ditentukan server untuk target operasi.
verb

string

Nama kata kerja yang dijalankan oleh operasi.
status_message

string

Status operasi yang dapat dibaca manusia, jika ada.
requested_cancellation

bool

Mengidentifikasi apakah pengguna telah meminta pembatalan operasi. Operasi yang berhasil dibatalkan memiliki nilai google.longrunning.Operation.error dengan google.rpc.Status.code 1, yang sesuai dengan Code.CANCELLED.
api_version

string

Versi API yang digunakan untuk memulai operasi.
endpoint

string

Nama endpoint API operasi ini.

ResetInstanceRequest

Permintaan untuk mereset instance notebook

Kolom
name

string

Wajib. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Otorisasi memerlukan izin IAM berikut pada name resource yang ditentukan:

  • notebooks.instances.reset

ResizeDiskRequest

Permintaan untuk mengubah ukuran disk instance notebook

Kolom
notebook_instance

string

Wajib. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Otorisasi memerlukan izin IAM berikut pada notebookInstance resource yang ditentukan:

  • notebooks.instances.update
Kolom union Disk. Jenis disk yang dapat diubah ukurannya: disk boot atau data Disk hanya dapat berupa salah satu dari berikut:
boot_disk

BootDisk

Wajib. Boot disk yang akan diubah ukurannya. Hanya disk_size_gb yang akan digunakan.
data_disk

DataDisk

Wajib. Disk data yang akan diubah ukurannya. Hanya disk_size_gb yang akan digunakan.

RestoreInstanceRequest

Permintaan untuk memulihkan instance notebook dari BackupSource.

Kolom
name

string

Wajib. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Otorisasi memerlukan izin IAM berikut pada name resource yang ditentukan:

  • notebooks.instances.update
Kolom union Source. Sumber yang akan dipulihkan. Source hanya ada berupa salah satu diantara berikut:
snapshot

Snapshot

Snapshot yang akan digunakan untuk pemulihan.

RollbackInstanceRequest

Permintaan untuk mengembalikan instance notebook ke versi sebelumnya

Kolom
name

string

Wajib. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Otorisasi memerlukan izin IAM berikut pada name resource yang ditentukan:

  • notebooks.instances.rollback
target_snapshot

string

Wajib. Snapshot untuk rollback. Contoh: "projects/test-project/global/snapshots/krwlzipynril".
revision_id

string

Wajib. Hanya output. ID Revisi

ServiceAccount

Akun layanan yang bertindak sebagai identitas.

Kolom
email

string

Opsional. Alamat email akun layanan.
scopes[]

string

Hanya output. Daftar cakupan yang akan tersedia untuk akun layanan ini. Ditetapkan oleh CLH ke https://www.googleapis.com/auth/cloud-platform

ShieldedInstanceConfig

Kumpulan opsi Instance Terlindungi. Lihat Image yang menggunakan fitur Shielded VM yang didukung. Tidak semua kombinasi valid.

Kolom
enable_secure_boot

bool

Opsional. Menentukan apakah instance VM mengaktifkan Booting Aman.

Booting Aman membantu memastikan bahwa sistem hanya menjalankan software asli dengan memverifikasi tanda tangan digital semua komponen booting, dan menghentikan proses booting jika verifikasi tanda tangan gagal. Dinonaktifkan secara default.
enable_vtpm

bool

Opsional. Menentukan apakah instance VM mengaktifkan vTPM.
enable_integrity_monitoring

bool

Opsional. Menentukan apakah pemantauan integritas diaktifkan untuk instance VM.

Mengaktifkan pemantauan dan pengesahan integritas booting instance VM. Pengesahan dilakukan terhadap dasar pengukuran kebijakan integritas. Baseline ini awalnya berasal dari image boot yang secara implisit tepercaya saat instance VM dibuat.

Snapshot

Snapshot merepresentasikan snapshot disk data yang digunakan untuk memulihkan Instance Workbench. Dirujuk oleh: compute/v1/projects/{project_id}/global/snapshots/{snapshot_id}

Kolom
snapshot_id

string

Wajib. ID snapshot.
project_id

string

Wajib. Project ID snapshot.

StartInstanceRequest

Permintaan untuk memulai instance notebook

Kolom
name

string

Wajib. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Otorisasi memerlukan izin IAM berikut pada name resource yang ditentukan:

  • notebooks.instances.start

Negara Bagian

Definisi status instance ini.

Enum
STATE_UNSPECIFIED Negara bagian tidak ditentukan.
STARTING Logika kontrol sedang memulai instance.
PROVISIONING Logika kontrol menginstal framework yang diperlukan dan mendaftarkan instance dengan proxy notebook
ACTIVE Instance sedang berjalan.
STOPPING Logika kontrol menghentikan instance.
STOPPED Instance dihentikan.
DELETED Instance dihapus.
UPGRADING Instance sedang diupgrade.
INITIALIZING Instance sedang dibuat.
SUSPENDING Instance sedang ditangguhkan.
SUSPENDED Instance ditangguhkan.

StopInstanceRequest

Permintaan untuk menghentikan instance notebook

Kolom
name

string

Wajib. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Otorisasi memerlukan izin IAM berikut pada name resource yang ditentukan:

  • notebooks.instances.stop

SupportedValues

SupportedValues mewakili nilai yang didukung oleh konfigurasi.

Kolom
machine_types[]

string

Hanya output. Jenis mesin yang didukung oleh WbI.
accelerator_types[]

string

Hanya output. Jenis akselerator yang didukung oleh WbI.

UpdateInstanceRequest

Permintaan untuk memperbarui instance notebook.

Kolom
instance

Instance

Wajib. Representasi instance.

Otorisasi memerlukan izin IAM berikut pada instance resource yang ditentukan:

  • iam.permissions.none
update_mask

FieldMask

Wajib. Mask yang digunakan untuk memperbarui instance. Kolom yang dapat diperbarui:

  • labels
  • gce_setup.min_cpu_platform
  • gce_setup.metadata
  • gce_setup.machine_type
  • gce_setup.accelerator_configs
  • gce_setup.accelerator_configs.type
  • gce_setup.accelerator_configs.core_count
  • gce_setup.gpu_driver_config
  • gce_setup.gpu_driver_config.enable_gpu_driver
  • gce_setup.gpu_driver_config.custom_gpu_driver_path
  • gce_setup.shielded_instance_config
  • gce_setup.shielded_instance_config.enable_secure_boot
  • gce_setup.shielded_instance_config.enable_vtpm
  • gce_setup.shielded_instance_config.enable_integrity_monitoring
  • gce_setup.reservation_affinity
  • gce_setup.reservation_affinity.consume_reservation_type
  • gce_setup.reservation_affinity.key
  • gce_setup.reservation_affinity.values
  • gce_setup.tags
  • gce_setup.container_image
  • gce_setup.container_image.repository
  • gce_setup.container_image.tag
  • gce_setup.disable_public_ip
  • disable_proxy_access
request_id

string

Opsional. UUID permintaan idempoten.

UpgradeHistoryEntry

Entri histori upgrade image VM.

Kolom
snapshot

string

Opsional. Snapshot disk booting instance notebook ini sebelum upgrade.
vm_image

string

Opsional. Image VM sebelum upgrade instance ini.
container_image

string

Opsional. Image container sebelum upgrade instance ini.
framework

string

Opsional. Framework instance notebook ini.
version

string

Opsional. Versi instance notebook sebelum upgrade ini.
state

State

Hanya output. Status entri histori upgrade instance ini.
create_time

Timestamp

Tidak dapat diubah. Waktu saat entri histori upgrade instance ini dibuat.
action

Action

Opsional. Tindakan. Rollback atau Upgrade.
target_version

string

Opsional. Versi VM Target, seperti m63.

Tindakan

Definisi operasi entri histori upgrade ini.

Enum
ACTION_UNSPECIFIED Operasi tidak ditentukan.
UPGRADE Upgrade.
ROLLBACK Rollback.

Negara Bagian

Definisi status entri histori upgrade ini.

Enum
STATE_UNSPECIFIED Negara bagian tidak ditentukan.
STARTED Upgrade instance dimulai.
SUCCEEDED Upgrade instance berhasil.
FAILED Upgrade instance gagal.

UpgradeInstanceRequest

Permintaan untuk mengupgrade instance notebook

Kolom
name

string

Wajib. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Otorisasi memerlukan izin IAM berikut pada name resource yang ditentukan:

  • notebooks.instances.upgrade

VmImage

Definisi image virtual machine Compute Engine kustom untuk memulai instance notebook dengan lingkungan yang diinstal langsung di VM.

Kolom
project

string

Wajib. Nama project Google Cloud tempat image VM ini berada. Format: {project_id}
Kolom union image. Referensi ke image VM Compute Engine eksternal. image hanya ada berupa salah satu diantara berikut:
name

string

Opsional. Gunakan nama image VM untuk menemukan image.
family

string

Opsional. Gunakan kelompok image VM ini untuk menemukan image; image terbaru dalam kelompok ini akan digunakan.