Descripción general de la API de Vertex AI Workbench
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
La interfaz de programación de aplicaciones (API) de Vertex AI Workbench es una interfaz programática para el servicio de Vertex AI Workbench.
Google compila las APIs del plano de control sobre Kubernetes, con el modelo de recursos de Kubernetes (KRM). El plano de control realiza la administración de recursos para servicios como la creación y eliminación de notebooks.
Acerca de la API de Vertex AI Workbench
Actualmente, el servicio de Vertex AI Workbench solo admite la API basada en Kubernetes (KRM). Consulta la página de KRM en la sección Vertex AI Workbench para conocer la funcionalidad equivalente de la interfaz de usuario (IU).
Extremo de servicio
La siguiente URL es el extremo de API de la API de KRM del servicio de Vertex AI Workbench:
Reemplaza ORG_ADMIN_CLUSTER_KUBERNETES_API_ENDPOINT por el extremo de la API del clúster de Kubernetes del administrador de tu organización.
Documento de descubrimiento
Usa el comando kubectl proxy --port=8001 para abrir un proxy al servidor de la API en tu máquina local. Desde allí, puedes acceder al documento de descubrimiento en la siguiente URL:
[[["Fácil de comprender","easyToUnderstand","thumb-up"],["Resolvió mi problema","solvedMyProblem","thumb-up"],["Otro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Información o código de muestra incorrectos","incorrectInformationOrSampleCode","thumb-down"],["Faltan la información o los ejemplos que necesito","missingTheInformationSamplesINeed","thumb-down"],["Problema de traducción","translationIssue","thumb-down"],["Otro","otherDown","thumb-down"]],["Última actualización: 2025-09-04 (UTC)"],[[["\u003cp\u003eThe Vertex AI Workbench API is a programmatic interface to the Vertex AI Workbench service, built on Kubernetes using the Kubernetes Resource Model (KRM) for resource management like Notebook creation and deletion.\u003c/p\u003e\n"],["\u003cp\u003eCurrently, the Vertex AI Workbench service only supports the Kubernetes-based (KRM) API, and its UI equivalent functionality can be found on the KRM page under the Vertex AI Workbench section.\u003c/p\u003e\n"],["\u003cp\u003eThe Vertex AI Workbench KRM API's functionality is currently limited to the features available in the UI, with no security guarantees or product support for actions beyond the UI capabilities.\u003c/p\u003e\n"],["\u003cp\u003eThe API endpoint for the Vertex AI Workbench service KRM API is https://\u003cvar translate=no\u003eORG_ADMIN_CLUSTER_KUBERNETES_API_ENDPOINT\u003c/var\u003e/apis/aiplatform.gdc.goog/v1, where \u003cvar translate=no\u003eORG_ADMIN_CLUSTER_KUBERNETES_API_ENDPOINT\u003c/var\u003e should be replaced with the admin cluster's API endpoint.\u003c/p\u003e\n"],["\u003cp\u003eThe discovery document for the API can be accessed via a local proxy by using \u003ccode\u003ekubectl proxy --port=8001\u003c/code\u003e and then navigating to http://127.0.0.1:8001/apis/aiplatform.gdc.goog/v1.\u003c/p\u003e\n"]]],[],null,["# Vertex AI Workbench API overview\n\nThe Vertex AI Workbench application programming interface (API) is a\nprogrammatic interface to the Vertex AI Workbench service.\nGoogle builds the control-plane APIs on top of Kubernetes, using the\nKubernetes Resource Model (KRM). The control plane performs resource management\nfor services such as Notebook creation and deletion.\n\nAbout Vertex AI Workbench API\n-----------------------------\n\nVertex AI Workbench service currently supports only the\nKubernetes-based (KRM) API. Refer to the KRM page under\nVertex AI Workbench section for the User Interface (UI) equivalent\nfunctionality.\n| **Note:** Currently, the Vertex AI Workbench KRM API doesn't support any functionality beyond the Vertex AI Workbench service provided in the UI. Therefore, if you choose to perform a KRM API action beyond the UI capability, there is no security guarantee or product support provided. If there is a need for supporting certain functionality on the UI, file a feature request to the Google Distributed Cloud (GDC) air-gapped product team.\n\nService endpoint\n----------------\n\nThe following URL is the API endpoint for the Vertex AI Workbench\nservice KRM API:\n\n- https://\u003cvar translate=\"no\"\u003eORG_ADMIN_CLUSTER_KUBERNETES_API_ENDPOINT\u003c/var\u003e/apis/aiplatform.gdc.goog/v1\n\nReplace \u003cvar translate=\"no\"\u003eORG_ADMIN_CLUSTER_KUBERNETES_API_ENDPOINT\u003c/var\u003e with the API\nendpoint of your organization admin Kubernetes cluster.\n\nDiscovery document\n------------------\n\nUse the `kubectl proxy --port=8001` command to open a proxy to the API server on\nyour local machine. From there, you can access the discovery document at the\nfollowing URL:\n\n- http://127.0.0.1:8001/apis/aiplatform.gdc.goog/v1"]]
