Package google.cloud.notebooks.v2

Indice

NotebookService

Servizio API v2 per le istanze di Workbench Notebooks.

CheckInstanceUpgradability

rpc CheckInstanceUpgradability(CheckInstanceUpgradabilityRequest) returns (CheckInstanceUpgradabilityResponse)

Controlla se è possibile eseguire l'upgrade di un'istanza notebook.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.
CreateInstance

rpc CreateInstance(CreateInstanceRequest) returns (Operation)

Crea una nuova istanza in un progetto e una località specifici.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.
DeleteInstance

rpc DeleteInstance(DeleteInstanceRequest) returns (Operation)

Elimina una singola istanza.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.
DiagnoseInstance

rpc DiagnoseInstance(DiagnoseInstanceRequest) returns (Operation)

Crea un file di diagnostica ed esegue lo strumento di diagnostica per una determinata istanza.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.
GetConfig

rpc GetConfig(GetConfigRequest) returns (Config)

Restituisce vari parametri di configurazione.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.
GetInstance

rpc GetInstance(GetInstanceRequest) returns (Instance)

Recupera i dettagli di una singola istanza.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.
ListInstances

rpc ListInstances(ListInstancesRequest) returns (ListInstancesResponse)

Elenca le istanze in un progetto e una località specifici.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.
ResetInstance

rpc ResetInstance(ResetInstanceRequest) returns (Operation)

Reimposta un'istanza notebook.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.
ResizeDisk

rpc ResizeDisk(ResizeDiskRequest) returns (Operation)

Ridimensiona un disco dell'istanza notebook a una capacità superiore.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.
RestoreInstance

rpc RestoreInstance(RestoreInstanceRequest) returns (Operation)

RestoreInstance ripristina un'istanza da un BackupSource.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.
RollbackInstance

rpc RollbackInstance(RollbackInstanceRequest) returns (Operation)

Esegue il rollback di un'istanza di notebook alla versione precedente.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.
StartInstance

rpc StartInstance(StartInstanceRequest) returns (Operation)

Avvia un'istanza di notebook.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.
StopInstance

rpc StopInstance(StopInstanceRequest) returns (Operation)

Arresta un'istanza notebook.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.
UpdateInstance

rpc UpdateInstance(UpdateInstanceRequest) returns (Operation)

UpdateInstance aggiorna un'istanza.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.
UpgradeInstance

rpc UpgradeInstance(UpgradeInstanceRequest) returns (Operation)

Esegue l'upgrade di un'istanza di notebook all'ultima versione.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.

AcceleratorConfig

Una configurazione dell'acceleratore per una definizione di istanza VM di un acceleratore hardware. Tieni presente che non viene eseguito alcun controllo sulle combinazioni di type e core_count. Le TPU non sono supportate. Consulta la sezione GPU su Compute Engine per trovare una combinazione valida.

Campi
type

AcceleratorType

Facoltativo. Tipo di questo acceleratore.
core_count

int64

Facoltativo. Conteggio dei core di questo acceleratore.

AcceleratorType

Definizione dei tipi di acceleratori hardware che possono essere utilizzati in questa istanza.

Enum
ACCELERATOR_TYPE_UNSPECIFIED Il tipo di acceleratore non è specificato.
NVIDIA_TESLA_P100 Il tipo di acceleratore è Nvidia Tesla P100.
NVIDIA_TESLA_V100 Il tipo di acceleratore è Nvidia Tesla V100.
NVIDIA_TESLA_P4 Il tipo di acceleratore è Nvidia Tesla P4.
NVIDIA_TESLA_T4 Il tipo di acceleratore è Nvidia Tesla T4.
NVIDIA_TESLA_A100 Il tipo di acceleratore è Nvidia Tesla A100 - 40 GB.
NVIDIA_A100_80GB Il tipo di acceleratore è Nvidia Tesla A100 - 80 GB.
NVIDIA_L4 Il tipo di acceleratore è Nvidia Tesla L4.
NVIDIA_H100_80GB Il tipo di acceleratore è Nvidia Tesla H100 - 80 GB.
NVIDIA_H100_MEGA_80GB Il tipo di acceleratore è Nvidia Tesla H100 - MEGA 80 GB.
NVIDIA_H200_141GB Il tipo di acceleratore è Nvidia Tesla H200 - 141 GB.
NVIDIA_TESLA_T4_VWS Il tipo di acceleratore è workstation virtuali NVIDIA Tesla T4.
NVIDIA_TESLA_P100_VWS Il tipo di acceleratore è NVIDIA Tesla P100 Virtual Workstations.
NVIDIA_TESLA_P4_VWS Il tipo di acceleratore è workstation virtuali NVIDIA Tesla P4.
NVIDIA_B200 Il tipo di acceleratore è NVIDIA B200.

AccessConfig

Una configurazione di accesso collegata all'interfaccia di rete di un'istanza.

Campi
external_ip

string

Un indirizzo IP esterno associato a questa istanza. Specifica un indirizzo IP esterno statico non utilizzato disponibile per il progetto o lascia questo campo non definito per utilizzare un IP da un pool condiviso di indirizzi IP temporanei. Se specifichi un indirizzo IP esterno statico, questo deve trovarsi nella stessa regione della zona dell'istanza.

BootDisk

La definizione di un disco di avvio.

Campi
disk_size_gb

int64

Facoltativo. La dimensione del disco di avvio in GB collegato a questa istanza, fino a un massimo di 64.000 GB (64 TB). Se non specificato, il valore predefinito è il valore consigliato di 150 GB.
disk_type

DiskType

Facoltativo. Indica il tipo di disco.
disk_encryption

DiskEncryption

Facoltativo. Solo input. Metodo di crittografia del disco utilizzato sui dischi di avvio e dati, il valore predefinito è GMEK.
kms_key

string

Facoltativo. Solo input. La chiave KMS utilizzata per criptare i dischi, applicabile solo se disk_encryption è CMEK. Formato: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

Scopri di più sull'utilizzo delle tue chiavi di crittografia.

CheckInstanceUpgradabilityRequest

Richiesta di controllo per verificare se è possibile eseguire l'upgrade di un'istanza notebook.

Campi
notebook_instance

string

Obbligatorio. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

L'autorizzazione richiede il seguente permesso IAM per la risorsa notebookInstance specificata:

  • notebooks.instances.checkUpgradability

CheckInstanceUpgradabilityResponse

Risposta per verificare se è possibile eseguire l'upgrade di un'istanza notebook.

Campi
upgradeable

bool

Se è possibile eseguire l'upgrade di un'istanza.
upgrade_version

string

La versione a cui verrà eseguito l'upgrade di questa istanza se viene chiamato l'endpoint di upgrade. Questo campo verrà compilato solo se field_upgradeable è true.
upgrade_info

string

Informazioni aggiuntive sull'upgrade.
upgrade_image

string

Il nuovo self-link dell'immagine a cui verrà eseguito l'upgrade di questa istanza se viene chiamato l'endpoint di upgrade. Questo campo verrà compilato solo se field_upgradeable è true.

ConfidentialInstanceConfig

Un insieme di opzioni di istanza confidenziale.

Campi
confidential_instance_type

ConfidentialInstanceType

Facoltativo. Definisce il tipo di tecnologia utilizzata dall'istanza confidenziale.

ConfidentialInstanceType

Il tipo di istanza confidenziale.

Enum
CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED Nessun tipo specificato. Non utilizzare questo valore.
SEV AMD Secure Encrypted Virtualization.

Configurazione

Risposta per ottenere le configurazioni WbI in una località

Campi
default_values

DefaultValues

Solo output. I valori predefiniti per la configurazione.
supported_values

SupportedValues

Solo output. I valori supportati per la configurazione.
available_images[]

ImageRelease

Solo output. L'elenco delle immagini disponibili per creare un WbI.
disable_workbench_legacy_creation

bool

Solo output. Flag per disattivare la creazione di notebook Workbench legacy (notebook gestiti dall'utente e notebook gestiti da Google).

ContainerImage

Definizione di un'immagine container per avviare un'istanza notebook con l'ambiente installato in un container.

Campi
repository

string

Obbligatorio. Il percorso del repository dell'immagine container. Ad esempio: gcr.io/{project_id}/{image_name}
tag

string

Facoltativo. Il tag dell'immagine container. Se non specificato, il valore predefinito è l'ultimo tag.

CreateInstanceRequest

Richiesta di creazione di un'istanza di notebook.

Campi
parent

string

Obbligatorio. Formato: parent=projects/{project_id}/locations/{location}

L'autorizzazione richiede il seguente permesso IAM per la risorsa parent specificata:

  • notebooks.instances.create
instance_id

string

Obbligatorio. ID univoco definito dall'utente di questa istanza.
instance

Instance

Obbligatorio. L'istanza da creare.
request_id

string

Facoltativo. UUID della richiesta idempotente.

DataDisk

Una risorsa disco collegata a un'istanza.

Campi
disk_size_gb

int64

Facoltativo. La dimensione del disco in GB collegato a questa istanza VM, fino a un massimo di 64.000 GB (64 TB). Se non specificato, il valore predefinito è 100.
disk_type

DiskType

Facoltativo. Solo input. Indica il tipo di disco.
disk_encryption

DiskEncryption

Facoltativo. Solo input. Metodo di crittografia del disco utilizzato sui dischi di avvio e dati, il valore predefinito è GMEK.
kms_key

string

Facoltativo. Solo input. La chiave KMS utilizzata per criptare i dischi, applicabile solo se disk_encryption è CMEK. Formato: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

Scopri di più sull'utilizzo delle tue chiavi di crittografia.
resource_policies[]

string

Facoltativo. I criteri della risorsa da applicare al disco di dati.

DefaultValues

DefaultValues rappresenta i valori di configurazione predefiniti.

Campi
machine_type

string

Solo output. Il tipo di macchina predefinito utilizzato dal backend se non fornito dall'utente.

DeleteInstanceRequest

Richiesta di eliminazione di un'istanza di notebook.

Campi
name

string

Obbligatorio. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

L'autorizzazione richiede il seguente permesso IAM per la risorsa name specificata:

  • notebooks.instances.delete
request_id

string

Facoltativo. UUID della richiesta idempotente.

DiagnoseInstanceRequest

Richiesta di creazione di un file di diagnostica dell'istanza di blocco note.

Campi
name

string

Obbligatorio. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

L'autorizzazione richiede il seguente permesso IAM per la risorsa name specificata:

  • notebooks.instances.diagnose
diagnostic_config

DiagnosticConfig

Obbligatorio. Definisce i flag utilizzati per eseguire lo strumento di diagnostica
timeout_minutes

int32

Facoltativo. Quantità massima di tempo in minuti prima del timeout dell'operazione.

DiagnosticConfig

Definisce i flag utilizzati per eseguire lo strumento di diagnostica

Campi
gcs_bucket

string

Obbligatorio. (OBBLIGATORIO) Posizione del bucket Cloud Storage dell'utente. Deve essere formattato con il prefisso del percorso (gs://$GCS_BUCKET).

Autorizzazioni: User Managed Notebooks: - storage.buckets.writer: deve essere concesso al account di servizio del progetto collegato alla VM. Google Managed Notebooks: - storage.buckets.writer: deve essere concesso al account di servizio del progetto o alle credenziali utente associate alla VM a seconda della modalità di autenticazione.

Il file di log del bucket Cloud Storage verrà scritto in gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
relative_path

string

Facoltativo. Definisce il percorso di archiviazione relativo nel bucket Cloud Storage in cui verranno scritti i log di diagnostica: il percorso predefinito sarà la directory radice del bucket Cloud Storage (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz). Esempio di percorso completo in cui verrà scritto il file di log: gs://$GCS_BUCKET/$RELATIVE_PATH/
enable_repair_flag

bool

Facoltativo. Attiva il flag per il servizio di riparazione per l'istanza
enable_packet_capture_flag

bool

Facoltativo. Attiva il flag per acquisire pacchetti dall'istanza per 30 secondi
enable_copy_home_files_flag

bool

Facoltativo. Attiva il flag per copiare tutti i contenuti della cartella /home/jupyter

DiskEncryption

Definizione delle opzioni di crittografia del disco.

Enum
DISK_ENCRYPTION_UNSPECIFIED La crittografia del disco non è specificata.
GMEK Utilizza le chiavi di crittografia gestite da Google per criptare il disco di avvio.
CMEK Utilizza le chiavi di crittografia gestite dal cliente per criptare il disco di avvio.

DiskType

Tipi di disco possibili.

Enum
DISK_TYPE_UNSPECIFIED Tipo di disco non impostato.
PD_STANDARD Tipo di Standard disco permanente.
PD_SSD Tipo di disco permanente SSD.
PD_BALANCED Tipo di disco permanente bilanciato.
PD_EXTREME Tipo di disco permanente con carico estremo.
HYPERDISK_BALANCED Rappresenta il tipo di disco permanente Hyperdisk Balanced. Può essere utilizzato come disco di avvio o disco di dati.
HYPERDISK_EXTREME Rappresenta il tipo di disco permanente Hyperdisk Extreme. Può essere utilizzato solo come disco di dati.
HYPERDISK_THROUGHPUT Rappresenta il tipo di disco permanente Hyperdisk Throughput. Può essere utilizzato solo come disco di dati.
HYPERDISK_BALANCED_HIGH_AVAILABILITY Rappresenta il tipo di disco permanente Hyperdisk Balanced High Availability. Può essere utilizzato come disco di avvio o disco di dati.
HYPERDISK_ML Rappresenta il tipo di disco permanente Hyperdisk ML. Può essere utilizzato come disco di avvio o disco di dati.

GPUDriverConfig

Una configurazione del driver GPU

Campi
enable_gpu_driver

bool

Facoltativo. Indica se l'utente finale autorizza Google Cloud a installare il driver della GPU su questa istanza VM. Se questo campo è vuoto o impostato su false, il driver GPU non verrà installato. Applicabile solo alle istanze con GPU.
custom_gpu_driver_path

string

Facoltativo. Specifica un percorso Cloud Storage personalizzato in cui è memorizzato il driver della GPU. Se non specificati, scegliamo automaticamente tra i driver GPU ufficiali.

GceSetup

La definizione di come configurare un'istanza VM al di fuori di Risorse e identità.

Campi
machine_type

string

Facoltativo. Il tipo di macchina dell'istanza VM. https://cloud.google.com/compute/docs/machine-resource
min_cpu_platform

string

Facoltativo. La piattaforma CPU minima da utilizzare per questa istanza. L'elenco dei valori validi è disponibile all'indirizzo https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform#availablezones
accelerator_configs[]

AcceleratorConfig

Facoltativo. Gli acceleratori hardware utilizzati in questa istanza. Se utilizzi acceleratori, assicurati che la configurazione disponga di vCPU e memoria sufficienti per supportare il machine_type che hai selezionato. Attualmente supporta una sola configurazione dell'acceleratore.
service_accounts[]

ServiceAccount

Facoltativo. Il account di servizio che funge da identità per l'istanza VM. Al momento supporta un solo account di servizio.
boot_disk

BootDisk

Facoltativo. Il disco di avvio della VM.
data_disks[]

DataDisk

Facoltativo. Dischi di dati collegati all'istanza VM. Al momento supporta solo un disco di dati.
shielded_instance_config

ShieldedInstanceConfig

Facoltativo. Configurazione di Shielded VM. Immagini che utilizzano le funzionalità Shielded VM supportate.
network_interfaces[]

NetworkInterface

Facoltativo. Le interfacce di rete per la VM. Supporta una sola interfaccia.
disable_public_ip

bool

Facoltativo. Se è true, a questa istanza VM non verrà assegnato alcun IP esterno.
tags[]

string

Facoltativo. I tag di rete Compute Engine da aggiungere al runtime (vedi Aggiungere tag di rete).
metadata

map<string, string>

Facoltativo. Metadati personalizzati da applicare a questa istanza.
enable_ip_forwarding

bool

Facoltativo. Flag per attivare o meno l'inoltro IP, il valore predefinito è false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward
gpu_driver_config

GPUDriverConfig

Facoltativo. Configurazione dei driver GPU.
confidential_instance_config

ConfidentialInstanceConfig

Facoltativo. Configurazione dell'istanza confidenziale.
instance_id

string

Solo output. L'ID univoco della risorsa istanza di Compute Engine.
Campo unione image. Tipo di immagine; può essere un'immagine VM o un'immagine container. image può essere solo uno dei seguenti tipi:
vm_image

VmImage

Facoltativo. Utilizza un'immagine VM di Compute Engine per avviare l'istanza del blocco note.
container_image

ContainerImage

Facoltativo. Utilizza un'immagine container per avviare l'istanza del blocco note.

GetConfigRequest

Richiesta per ottenere i parametri di configurazione di Workbench.

Campi
name

string

Obbligatorio. Formato: projects/{project_id}/locations/{location}

GetInstanceRequest

Richiesta di ottenere un'istanza notebook.

Campi
name

string

Obbligatorio. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

L'autorizzazione richiede il seguente permesso IAM per la risorsa name specificata:

  • notebooks.instances.get

HealthState

Lo stato di integrità dell'istanza.

Enum
HEALTH_STATE_UNSPECIFIED Il sottostato dell'istanza è sconosciuto.
HEALTHY È noto che l'istanza è in stato integro (ad esempio, i daemon critici sono in esecuzione). Si applica allo stato ACTIVE.
UNHEALTHY È noto che l'istanza si trova in uno stato non integro (ad esempio, i daemon critici non sono in esecuzione). Si applica allo stato ACTIVE.
AGENT_NOT_INSTALLED L'istanza non ha installato l'agente di monitoraggio dell'integrità. Si applica allo stato ATTIVO.
AGENT_NOT_RUNNING L'agente di monitoraggio dello stato di integrità dell'istanza non è in esecuzione. Si applica allo stato ATTIVO.

ImageRelease

ConfigImage rappresenta una release dell'immagine disponibile per creare un'istanza WbI

Campi
image_name

string

Solo output. Il nome dell'immagine nel formato workbench-instances-vYYYYmmdd--
release_name

string

Solo output. Il rilascio dell'immagine del modulo m123

Istanza

La definizione di un'istanza notebook.

Campi
name

string

Solo output. Identificatore. Il nome di questa istanza del notebook. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}
proxy_uri

string

Solo output. L'endpoint proxy utilizzato per accedere al notebook Jupyter.
instance_owners[]

string

Facoltativo. Il proprietario di questa istanza dopo la creazione. Formato: alias@example.com

Al momento supporta un solo proprietario. Se non specificato, tutti gli utenti del account di servizio dell'account di servizio possono utilizzare l'istanza.
creator

string

Solo output. Indirizzo email dell'entità che ha inviato la richiesta CreateInstance originale.
state

State

Solo output. Lo stato di questa istanza.
upgrade_history[]

UpgradeHistoryEntry

Solo output. La cronologia degli upgrade di questa istanza.
id

string

Solo output. ID univoco della risorsa.
health_state

HealthState

Solo output. Stato di integrità dell'istanza.
health_info

map<string, string>

Solo output. Informazioni aggiuntive sull'integrità dell'istanza. Esempio:

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

Solo output. Ora di creazione dell'istanza.
update_time

Timestamp

Solo output. Ora di aggiornamento dell'istanza.
disable_proxy_access

bool

Facoltativo. Se il valore è true, l'istanza del notebook non verrà registrata con il proxy.
labels

map<string, string>

Facoltativo. Etichette da applicare a questa istanza. Questi valori possono essere modificati in un secondo momento con il metodo UpdateInstance.
third_party_proxy_url

string

Solo output. L'endpoint proxy dei pool di forza lavoro utilizzato per accedere al notebook Jupyter.
satisfies_pzs

bool

Solo output. Riservato per l'uso futuro per la separazione delle zone.
satisfies_pzi

bool

Solo output. Riservato per l'uso futuro per l'isolamento della zona.
enable_third_party_identity

bool

Facoltativo. Flag che specifica che è possibile accedere a un blocco note con un provider di identità di terze parti.
enable_managed_euc

bool

Facoltativo. Flag per abilitare le credenziali utente finale gestite per l'istanza.
enable_deletion_protection

bool

Facoltativo. Se è true, la protezione da eliminazione verrà attivata per questa istanza di Workbench. Se è false, la protezione da eliminazione verrà disattivata per questa istanza di Workbench.
Campo unione infrastructure. Configurazione dell'istanza notebook. infrastructure può essere solo uno dei seguenti tipi:
gce_setup

GceSetup

Facoltativo. Configurazione di Compute Engine per il blocco note. Utilizza i campi definiti nel blocco note.

ListInstancesRequest

Richiesta di elencare le istanze di notebook.

Campi
parent

string

Obbligatorio. L'elemento principale dell'istanza. Formati: - projects/{project_id}/locations/{location} per elencare le istanze in una zona specifica. - projects/{project_id}/locations/- per elencare le istanze in tutte le località.

L'autorizzazione richiede il seguente permesso IAM per la risorsa parent specificata:

  • notebooks.instances.list
page_size

int32

Facoltativo. Dimensione massima di ritorno della chiamata di elenco.
page_token

string

Facoltativo. Un token di pagina restituito in precedenza che può essere utilizzato per continuare l'elenco dall'ultimo risultato.
order_by

string

Facoltativo. Ordina i risultati. I valori supportati sono "name", "name desc" o "" (non ordinato).
filter

string

Facoltativo. Filtro elenco.

ListInstancesResponse

Risposta per elencare le istanze di Notebooks.

Campi
instances[]

Instance

Un elenco di istanze restituite.
next_page_token

string

Token di pagina che può essere utilizzato per continuare l'elenco dall'ultimo risultato nella chiamata dell'elenco successivo.
unreachable[]

string

Elenco non ordinato. Località non raggiungibili. Ad esempio, ['projects/{project_id}/locations/us-west1-a', 'projects/{project_id}/locations/us-central1-b']. Una ListInstancesResponse conterrà solo istanze o elementi non raggiungibili,

NetworkInterface

La definizione di una risorsa di interfaccia di rete collegata a una VM.

Campi
network

string

Facoltativo. Il nome del VPC in cui si trova questa istanza VM. Formato: projects/{project_id}/global/networks/{network_id}
subnet

string

Facoltativo. Il nome della subnet in cui si trova questa istanza VM. Formato: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
nic_type

NicType

Facoltativo. Il tipo di vNIC da utilizzare su questa interfaccia. Può essere gVNIC o VirtioNet.
access_configs[]

AccessConfig

Facoltativo. Un array di configurazioni per questa interfaccia. Al momento è supportata solo una configurazione di accesso, ONE_TO_ONE_NAT. Se non viene specificato alcun accessConfigs, l'istanza avrà un accesso a internet esterno tramite un indirizzo IP esterno temporaneo.

NicType

Il tipo di driver vNIC. Il valore predefinito deve essere NIC_TYPE_UNSPECIFIED.

Enum
NIC_TYPE_UNSPECIFIED Nessun tipo specificato.
VIRTIO_NET VIRTIO
GVNIC gVNIC

OperationMetadata

Rappresenta i metadati dell'operazione a lunga esecuzione.

Campi
create_time

Timestamp

L'ora in cui è stata creata l'operazione.
end_time

Timestamp

L'ora in cui è terminata l'esecuzione dell'operazione.
target

string

Percorso della risorsa definito dal server per la destinazione dell'operazione.
verb

string

Nome del verbo eseguito dall'operazione.
status_message

string

Stato dell'operazione leggibile, se presente.
requested_cancellation

bool

Indica se l'utente ha richiesto l'annullamento dell'operazione. Le operazioni annullate correttamente hanno un valore google.longrunning.Operation.error con un google.rpc.Status.code pari a 1, corrispondente a Code.CANCELLED.
api_version

string

Versione dell'API utilizzata per avviare l'operazione.
endpoint

string

Nome dell'endpoint API di questa operazione.

ResetInstanceRequest

Richiesta di reimpostazione di un'istanza notebook

Campi
name

string

Obbligatorio. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

L'autorizzazione richiede il seguente permesso IAM per la risorsa name specificata:

  • notebooks.instances.reset

ResizeDiskRequest

Richiesta di ridimensionamento dei dischi dell'istanza notebook

Campi
notebook_instance

string

Obbligatorio. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

L'autorizzazione richiede il seguente permesso IAM per la risorsa notebookInstance specificata:

  • notebooks.instances.update
Campo unione Disk. Il tipo di disco che può essere ridimensionato: il disco di avvio o di dati Disk può essere solo uno dei seguenti:
boot_disk

BootDisk

Obbligatorio. Il disco di avvio da ridimensionare. Verrà utilizzato solo disk_size_gb.
data_disk

DataDisk

Obbligatorio. Il disco dati da ridimensionare. Verrà utilizzato solo disk_size_gb.

RestoreInstanceRequest

Richiesta di ripristino dell'istanza notebook da un BackupSource.

Campi
name

string

Obbligatorio. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

L'autorizzazione richiede il seguente permesso IAM per la risorsa name specificata:

  • notebooks.instances.update
Campo unione Source. Origine da cui eseguire il ripristino. Source può essere solo uno dei seguenti tipi:
snapshot

Snapshot

Snapshot da utilizzare per il ripristino.

RollbackInstanceRequest

Richiesta di rollback di un'istanza di notebook

Campi
name

string

Obbligatorio. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

L'autorizzazione richiede il seguente permesso IAM per la risorsa name specificata:

  • notebooks.instances.rollback
target_snapshot

string

Obbligatorio. Lo snapshot per il rollback. Esempio: "projects/test-project/global/snapshots/krwlzipynril".
revision_id

string

Obbligatorio. Solo output. ID revisione

ServiceAccount

Un account di servizio che funge da identità.

Campi
email

string

Facoltativo. Indirizzo email del account di servizio.
scopes[]

string

Solo output. L'elenco degli ambiti da rendere disponibili per questo account di servizio. Impostato da CLH su https://www.googleapis.com/auth/cloud-platform

ShieldedInstanceConfig

Un insieme di opzioni di Shielded Instance. Consulta Immagini che utilizzano le funzionalità Shielded VM supportate. Non tutte le combinazioni sono valide.

Campi
enable_secure_boot

bool

Facoltativo. Definisce se l'istanza VM ha l'avvio protetto abilitato.

Avvio protetto contribuisce ad assicurare che il sistema esegua solo software autentici verificando la firma digitale di tutti i componenti di avvio e interrompendo il processo di avvio se la firma non supera la verifica. Disabilitato per impostazione predefinita.
enable_vtpm

bool

Facoltativo. Definisce se la vTPM è abilitata nell'istanza VM.
enable_integrity_monitoring

bool

Facoltativo. Definisce se il monitoraggio dell'integrità è abilitato per l'istanza VM.

Consente il monitoraggio e l'attestazione dell'integrità in fase di avvio dell'istanza VM. L'attestazione viene eseguita rispetto alla baseline dei criteri di integrità. Questa baseline viene inizialmente derivata dall'immagine di avvio implicitamente attendibile quando viene creata l'istanza VM.

Snapshot

Snapshot rappresenta lo snapshot del disco di dati utilizzato per ripristinare l'istanza Workbench. Si riferisce a: compute/v1/projects/{project_id}/global/snapshots/{snapshot_id}

Campi
snapshot_id

string

Obbligatorio. L'ID dello snapshot.
project_id

string

Obbligatorio. L'ID progetto dello snapshot.

StartInstanceRequest

Richiesta di avvio di un'istanza di notebook

Campi
name

string

Obbligatorio. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

L'autorizzazione richiede il seguente permesso IAM per la risorsa name specificata:

  • notebooks.instances.start

Stato

La definizione degli stati di questa istanza.

Enum
STATE_UNSPECIFIED Lo stato non è specificato.
STARTING La logica di controllo sta avviando l'istanza.
PROVISIONING La logica di controllo installa i framework richiesti e registra l'istanza con il proxy notebook
ACTIVE L'istanza è in esecuzione.
STOPPING La logica di controllo sta arrestando l'istanza.
STOPPED L'istanza è stata arrestata.
DELETED L'istanza è stata eliminata.
UPGRADING È in corso l'upgrade dell'istanza.
INITIALIZING L'istanza è in fase di creazione.
SUSPENDING L'istanza è in fase di sospensione.
SUSPENDED L'istanza è sospesa.

StopInstanceRequest

Richiesta di arresto di un'istanza di notebook

Campi
name

string

Obbligatorio. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

L'autorizzazione richiede il seguente permesso IAM per la risorsa name specificata:

  • notebooks.instances.stop

SupportedValues

SupportedValues rappresenta i valori supportati dalla configurazione.

Campi
machine_types[]

string

Solo output. I tipi di macchine supportati da WbI.
accelerator_types[]

string

Solo output. I tipi di acceleratore supportati da WbI.

UpdateInstanceRequest

Richiesta di aggiornamento di un'istanza di notebook.

Campi
instance

Instance

Obbligatorio. Una rappresentazione di un'istanza.

L'autorizzazione richiede il seguente permesso IAM per la risorsa instance specificata:

  • iam.permissions.none
update_mask

FieldMask

Obbligatorio. Maschera utilizzata per aggiornare un'istanza. Campi aggiornabili:

  • 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

Facoltativo. UUID della richiesta idempotente.

UpgradeHistoryEntry

La voce della cronologia di upgrade dell'immagine VM.

Campi
snapshot

string

Facoltativo. Lo snapshot del disco di avvio di questa istanza notebook prima dell'upgrade.
vm_image

string

Facoltativo. L'immagine VM prima dell'upgrade di questa istanza.
container_image

string

Facoltativo. L'immagine container prima dell'upgrade di questa istanza.
framework

string

Facoltativo. Il framework di questa istanza notebook.
version

string

Facoltativo. La versione dell'istanza notebook prima di questo upgrade.
state

State

Solo output. Lo stato di questa voce della cronologia di upgrade dell'istanza.
create_time

Timestamp

Immutabile. L'ora in cui viene creata questa voce della cronologia dell'upgrade dell'istanza.
action

Action

Facoltativo. Azione. Esegui il rollback o l'upgrade.
target_version

string

Facoltativo. Versione VM di destinazione, ad esempio m63.

Azione

La definizione delle operazioni di questa voce della cronologia degli upgrade.

Enum
ACTION_UNSPECIFIED L'operazione non è specificata.
UPGRADE Fai l'upgrade.
ROLLBACK Rollback.

Stato

La definizione degli stati di questa voce della cronologia degli upgrade.

Enum
STATE_UNSPECIFIED Lo stato non è specificato.
STARTED È stato avviato l'upgrade dell'istanza.
SUCCEEDED L'upgrade dell'istanza è stato completato.
FAILED L'upgrade dell'istanza non è riuscito.

UpgradeInstanceRequest

Richiesta di upgrade di un'istanza di notebook

Campi
name

string

Obbligatorio. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

L'autorizzazione richiede il seguente permesso IAM per la risorsa name specificata:

  • notebooks.instances.upgrade

VmImage

Definizione di un'immagine di macchina virtuale Compute Engine personalizzata per avviare un'istanza notebook con l'ambiente installato direttamente sulla VM.

Campi
project

string

Obbligatorio. Il nome del progetto Google Cloud a cui appartiene questa immagine VM. Formato: {project_id}
Campo unione image. Il riferimento a un'immagine VM di Compute Engine esterna. image può essere solo uno dei seguenti tipi:
name

string

Facoltativo. Utilizza il nome dell'immagine VM per trovare l'immagine.
family

string

Facoltativo. Utilizza questa famiglia di immagini VM per trovare l'immagine. Verrà utilizzata l'immagine più recente di questa famiglia.