Patch v2+name — notebooks

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13255283.1 KB

projects

UpdateInstance updates an Instance.

patch/v2/{+name}

Path parameters

namestring required

Output only. Identifier. The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Query parameters

requestIdstring

Optional. Idempotent request UUID.

updateMaskstring

Required. Mask used to update an instance. Updatable fields: * 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 body

createTimestring google-datetime

Output only. Instance creation time.

enableDeletionProtectionboolean

Optional. If true, deletion protection will be enabled for this Workbench Instance. If false, deletion protection will be disabled for this Workbench Instance.

instanceOwnersstring[]

Optional. The owner of this instance after creation. Format: alias@example.com Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.

Output only. The state of this instance.

satisfiesPziboolean

Output only. Reserved for future use for Zone Isolation.

proxyUristring

Output only. The proxy endpoint that is used to access the Jupyter notebook.

idstring

Output only. Unique ID of the resource.

updateTimestring google-datetime

Output only. Instance update time.

labelsobject

Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.

enableManagedEucboolean

Optional. Flag to enable managed end user credentials for the instance.

namestring

Output only. Identifier. The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

thirdPartyProxyUrlstring

Output only. The workforce pools proxy endpoint that is used to access the Jupyter notebook.

satisfiesPzsboolean

Output only. Reserved for future use for Zone Separation.

healthInfoobject

Output only. Additional information about instance health. Example: healthInfo": { "docker_proxy_agent_status": "1", "docker_status": "1", "jupyterlab_api_status": "-1", "jupyterlab_status": "-1", "updated": "2020-10-18 09:40:03.573409" }

healthState'HEALTH_STATE_UNSPECIFIED' | 'HEALTHY' | 'UNHEALTHY' | 'AGENT_NOT_INSTALLED' | 'AGENT_NOT_RUNNING'

Output only. Instance health_state.

enableThirdPartyIdentityboolean

Optional. Flag that specifies that a notebook can be accessed with third party identity provider.

creatorstring

Output only. Email address of entity that sent original CreateInstance request.

disableProxyAccessboolean

Optional. If true, the notebook instance will not register with the proxy.

Response

Successful response