Referência da API KRM do Vertex AI Workbench

Pacotes

aiplatform.gdc.goog/v1

O pacote v1 contém definições do esquema da API para o grupo da API aiplatform.gdc.goog v1.

Tipos de recursos

Bloco de notas

Notebook é o esquema da API Notebooks.

Aparece em: - NotebookList

Campo Descrição
apiVersion string aiplatform.gdc.goog/v1
kind string Notebook
metadata ObjectMeta Consulte a documentação da API Kubernetes para os campos de metadata.
spec NotebookSpec
status NotebookStatus

NotebookCondition

Aparece em: - NotebookStatus

Campo Descrição
type string O tipo de condição. Existem três valores possíveis: Running, Waiting e Terminated.
lastProbeTime Hora A hora em que o bloco de notas foi sondado pela última vez.
reason string Uma string que contém o motivo pelo qual o contentor se encontra no respetivo estado atual.
message string Uma string que contém uma mensagem detalhada sobre o estado atual do contentor.

NotebookError

NotebookError representa um erro que ocorreu ao atualizar os recursos do bloco de notas.

Aparece em: - NotebookStatus

Campo Descrição
errorMessage string Uma string que contém uma mensagem detalhada que descreve o estado Pod.
code string Uma string que contém o código de erro do Pod no respetivo estado atual, como VTXWB-E0000.

NotebookList

NotebookList contém uma lista de Notebook instâncias.

Campo Descrição
apiVersion string aiplatform.gdc.goog/v1
kind string NotebookList
metadata ListMeta Consulte a documentação da API Kubernetes para os campos de metadata.
items Matriz de blocos de notas

NotebookSpec

NotebookSpec define o estado pretendido do bloco de notas.

Aparece em: - Bloco de notas

Campo Descrição
template NotebookTemplateSpec Uma especificação para uma instância do notebook que descreve o estado pretendido da carga de trabalho do notebook no cluster.

NotebookStatus

NotebookStatus define o estado observado do bloco de notas.

Aparece em: - Bloco de notas

Campo Descrição
conditions NotebookCondition Descontinuada. Use a CR Notebook Events. Uma matriz de objetos NotebookCondition.
readyReplicas número inteiro O número de Pods criados pelo controlador StatefulSet com o respetivo Condition definido como Ready.
containerState ContainerState Descontinuado, use NotebookStatus.Phase. O estado do contentor subjacente. Para mais informações, consulte https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#containerstate-v1-core.
phase string Uma string que contém a fase Pod atual.
reason string Uma string que contém o motivo pelo qual o elemento Pod se encontra no respetivo estado atual.
podUnavailableTime Hora Se o bloco de notas não estiver atualmente em execução ou o controlador não tiver conseguido consultar o estado do pod, a hora em que foi observado pela primeira vez que o pod do bloco de notas não estava em execução.
error NotebookError O último erro ocorrido ao atualizar os recursos do bloco de notas. Este campo está vazio se a operação for bem-sucedida.

NotebookTemplateSpec

NotebookTemplateSpec define o estado pretendido do cluster.

Aparece em: - NotebookSpec

Campo Descrição
spec PodSpec Define os contentores, as variáveis de ambiente para o contentor e outras propriedades, como o nome do programador e o contexto de segurança. Para mais informações, consulte https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#podspec-v1-core.
userCluster string UserCluster é o nome do cluster de utilizadores onde a carga de trabalho do bloco de notas é criada. O cluster tem de ter recursos suficientes para executar a carga de trabalho especificada em PodSpec.