Compartir a través de

Grupo de comandos de api

  • Artículo

Nota:

Esta información se aplica a las versiones 0.205 y posteriores de la CLI de Databricks. La CLI de Databricks está en versión preliminar pública.

El uso de la CLI de Databricks está sujeto a la licencia de Databricks y al aviso de privacidad de Databricks, incluidas las disposiciones de datos de uso.

El api grupo de comandos de la CLI de Databricks permite llamar a cualquier API de REST de Databricks disponible.

Solo debe ejecutar el comando api para escenarios avanzados, como versiones preliminares de api REST específicas de Databricks para las que la CLI de Databricks aún no encapsula la API REST de Databricks de destino dentro de un comando relacionado. Para obtener una lista de grupos de comandos encapsulados, consulte Comandos de la CLI de Databricks.

Para instalar la CLI de Databricks, consulte Instalación o actualización de la CLI de Databricks. Para configurar la autenticación de la CLI de Databricks, consulte Autenticación de la CLI de Databricks.

Ejecutar comandos api (solo para escenarios avanzados)

Los comandos api se ejecutan añadiéndolos a databricks api. Para mostrar la ayuda para el comando api, ejecute databricks api -h.

Para llamar al comando api, use el siguiente formato:

databricks api <http-method> <rest-api-path> [--json {<request-body> | @<filename>}]

En la llamada anterior:

  • Reemplace <http-method> por el método HTTP de la API de REST de Databricks a la que desea llamar, como delete, get, head, path, post o put. Por ejemplo, para devolver la lista de clústeres disponibles para un área de trabajo, use get. Para obtener el método HTTP correcto para la API de REST de Databricks a la que quiere llamar, consulte la documentación de la API de REST de Databricks.
  • Reemplace <rest-api-path> por la ruta de acceso a la API de REST de Databricks a la que desea llamar. No incluya https:// ni el nombre de la instancia del área de trabajo. Por ejemplo, para devolver la lista de clústeres disponibles para un área de trabajo, use /api/2.0/clusters/list. Para obtener la sintaxis correcta para la API de REST de Databricks a la que quiere llamar, consulte la documentación de la API de REST de Databricks.
  • Si la API de REST de Databricks a la que desea llamar requiere un cuerpo de solicitud, incluya --json y <request-body>, reemplazando <request-body> por el cuerpo de la solicitud en formato JSON. Como alternativa, puede almacenar el cuerpo de la solicitud en un archivo JSON independiente. Para ello, incluya --json y @<filename>, reemplazando <filename> por el nombre del archivo JSON. Para obtener la sintaxis correcta del cuerpo de la solicitud que desea incluir, consulte la documentación de la API de REST de Databricks.

Ejemplos

Obtenga la lista de clústeres disponibles en el área de trabajo.

databricks api get /api/2.0/clusters/list

Obtenga información sobre el clúster especificado en el área de trabajo.

databricks api post /api/2.0/clusters/get --json '{
   "cluster_id": "1234-567890-abcde123"
}'

Actualice la configuración del clúster especificado en el área de trabajo.

databricks api post /api/2.0/clusters/edit --json '{
  "cluster_id": "1234-567890-abcde123",
  "cluster_name": "my-changed-cluster",
  "num_workers": 1,
  "spark_version": "11.3.x-scala2.12",
  "node_type_id": "Standard_DS3_v2"
}'

Actualice la configuración del clúster especificado en el área de trabajo. Obtenga el cuerpo de la solicitud de un archivo denominado edit-cluster.json dentro del directorio de trabajo actual.

databricks api post /api/2.0/clusters/edit --json @edit-cluster.json

edit-cluster.json:

{
  "cluster_id": "1234-567890-abcde123",
  "cluster_name": "my-changed-cluster",
  "num_workers": 1,
  "spark_version": "11.3.x-scala2.12",
  "node_type_id": "Standard_DS3_v2"
}