GOgoogle
projects

GET /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}

Gets a NotebookRuntime.

Request

  • Base URL
    https://aiplatform.googleapis.com
  • Auth
    OAuth 2 and OAuth 2
    Implicit: https://accounts.google.com/o/oauth2/auth
    Scopes: https://www.googleapis.com/auth/cloud-platform
    Authorization code: https://accounts.google.com/o/oauth2/auth
    Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform

Path parameters

projectsIdstring required
locationsIdstring required
notebookRuntimesIdstring required

Response

Successful response

createTimestring google-datetime

Output only. Timestamp when this NotebookRuntime was created.

descriptionstring

The description of the NotebookRuntime.

displayNamestring

Required. The display name of the NotebookRuntime. The name can be up to 128 characters long and can consist of any UTF-8 characters.

expirationTimestring google-datetime

Output only. Timestamp when this NotebookRuntime will be expired: 1. System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted. 2. User created NotebookRuntime: 6 months after last upgrade. After expiration, user created runtime will be stopped and allowed for upgrade.

healthState'HEALTH_STATE_UNSPECIFIED' | 'HEALTHY' | 'UNHEALTHY'

Output only. The health state of the NotebookRuntime.

isUpgradableboolean

Output only. Whether NotebookRuntime is upgradable.

labelsobject

The labels with user-defined metadata to organize your NotebookRuntime. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one NotebookRuntime (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for NotebookRuntime: * "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output only, its value is the Compute Engine instance id. * "aiplatform.googleapis.com/colab_enterprise_entry_service": its value is either "bigquery" or "vertex"; if absent, it should be "vertex". This is to describe the entry service, either BigQuery or Vertex.

namestring

Output only. The resource name of the NotebookRuntime.

networkTagsstring[]

Optional. The Compute Engine tags to add to runtime (see Tagging instances).

notebookRuntimeType'NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED' | 'USER_DEFINED' | 'ONE_CLICK'

Output only. The type of the notebook runtime.

proxyUristring

Output only. The proxy endpoint used to access the NotebookRuntime.

runtimeState'RUNTIME_STATE_UNSPECIFIED' | 'RUNNING' | 'BEING_STARTED' | 'BEING_STOPPED' | 'STOPPED' | 'BEING_UPGRADED' | 'ERROR' | 'INVALID'

Output only. The runtime (instance) state of the NotebookRuntime.

runtimeUserstring

Required. The user email of the NotebookRuntime.

satisfiesPziboolean

Output only. Reserved for future use.

satisfiesPzsboolean

Output only. Reserved for future use.

serviceAccountstring

Output only. Deprecated: This field is no longer used and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. The service account that the NotebookRuntime workload runs as.

updateTimestring google-datetime

Output only. Timestamp when this NotebookRuntime was most recently updated.

versionstring

Output only. The VM os image version of NotebookRuntime.

Changes

No recorded changes to this operation across all 8 revisions of this API.