Referencia de la API KRM de Vertex AI Workbench

Paquetes

aiplatform.gdc.goog/v1

El paquete v1 contiene definiciones de esquemas de API para el grupo de APIs aiplatform.gdc.goog v1.

Tipos de recursos

Cuaderno

Notebook es el esquema de la API Notebooks.

Aparece en: - NotebookList

Campo Descripción
apiVersion string aiplatform.gdc.goog/v1
kind string Notebook
metadata ObjectMeta Consulta la documentación de la API de Kubernetes para ver los campos de metadata.
spec NotebookSpec
status NotebookStatus

NotebookCondition

Aparece en: - NotebookStatus

Campo Descripción
type string El tipo de condición. Hay tres valores posibles: Running, Waiting y Terminated.
lastProbeTime Hora Hora a la que se sondeó el cuaderno por última vez.
reason string Cadena que contiene el motivo por el que el contenedor está en su estado actual.
message string Cadena que contiene un mensaje detallado sobre el estado actual del contenedor.

NotebookError

NotebookError representa un error que se ha producido al actualizar los recursos de Notebook.

Aparece en: - NotebookStatus

Campo Descripción
errorMessage string Cadena que contiene un mensaje detallado que describe el estado Pod.
code string Cadena que contiene el código de error de Pod en su estado actual, como VTXWB-E0000.

NotebookList

NotebookList contiene una lista de instancias de Notebook.

Campo Descripción
apiVersion string aiplatform.gdc.goog/v1
kind string NotebookList
metadata ListMeta Consulta la documentación de la API de Kubernetes para ver los campos de metadata.
items Matriz de cuadernos

NotebookSpec

NotebookSpec define el estado deseado del cuaderno.

Aparece en: - Cuaderno

Campo Descripción
template NotebookTemplateSpec Especificación de una instancia de Notebook que describe el estado deseado de la carga de trabajo del cuaderno en el clúster.

NotebookStatus

NotebookStatus define el estado observado del cuaderno.

Aparece en: - Cuaderno

Campo Descripción
conditions Matriz NotebookCondition Obsoleto, usa la respuesta predefinida Notebook Events. Matriz de objetos NotebookCondition.
readyReplicas entero El número de Pods creados por el controlador StatefulSet con su Condition definido como Ready.
containerState ContainerState Obsoleto, usa NotebookStatus.Phase. El estado del contenedor subyacente. Para obtener más información, consulta https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#containerstate-v1-core.
phase string Cadena que contiene la fase Pod actual.
reason string Cadena que contiene el motivo por el que el Pod está en su estado actual.
podUnavailableTime Hora Si el cuaderno no se está ejecutando o el controlador no ha podido consultar el estado del pod, se indica la hora en la que se observó por primera vez que el pod del cuaderno no se estaba ejecutando.
error NotebookError El último error que se ha producido al actualizar los recursos de Notebook. Este campo está vacío si la operación se realiza correctamente.

NotebookTemplateSpec

NotebookTemplateSpec define el estado deseado del clúster.

Aparece en: - NotebookSpec

Campo Descripción
spec PodSpec Define los contenedores, las variables de entorno del contenedor y otras propiedades, como el nombre del programador y el contexto de seguridad. Para obtener más información, consulta https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#podspec-v1-core.
userCluster string UserCluster es el nombre del clúster de usuarios en el que se crea la carga de trabajo de Notebook. El clúster debe tener recursos suficientes para ejecutar la carga de trabajo especificada en PodSpec.