Dela via

api kommandogrupp

  • Artikel

Kommentar

Den här informationen gäller för Databricks CLI-versionerna 0.205 och senare. Databricks CLI finns i offentlig förhandsversion.

Databricks CLI-användning omfattas av Databricks-licensen och Databricks sekretessmeddelande, inklusive eventuella användningsdatabestämmelser.

Med api kommandogruppen i Databricks CLI kan du anropa alla tillgängliga Databricks REST API.

Du bör endast köra api kommandot för avancerade scenarier, till exempel förhandsversioner av specifika Databricks REST-API:er för vilka Databricks CLI inte redan omsluter mål-Databricks REST API i ett relaterat kommando. En lista över omslutna kommandogrupper finns i Databricks CLI-kommandon.

Information om hur du installerar Databricks CLI finns i Installera eller uppdatera Databricks CLI-. Information om hur du konfigurerar autentisering för Databricks CLI finns i Autentisering för Databricks CLI.

Kör api kommandon (endast för avancerade scenarier)

Du kör api kommandon genom att lägga till dem i databricks api. Om du vill visa hjälp för api kommandot kör du databricks api -h.

Om du vill anropa api kommandot använder du följande format:

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

I föregående anrop:

  • Ersätt <http-method> med HTTP-metoden för Databricks REST API som du vill anropa, till exempel delete, get, head, path, posteller put. Om du till exempel vill returnera listan över tillgängliga kluster för en arbetsyta använder du get. Information om hur du hämtar rätt HTTP-metod för Databricks REST API som du vill anropa finns i dokumentationen för Databricks REST API.
  • Ersätt <rest-api-path> med sökvägen till Databricks REST API som du vill anropa. Inkludera https:// inte eller namnet på arbetsytans instans. Om du till exempel vill returnera listan över tillgängliga kluster för en arbetsyta använder du /api/2.0/clusters/list. Information om hur du hämtar rätt syntax för Databricks REST API som du vill anropa finns i dokumentationen för Databricks REST API.
  • Om Databricks REST API som du vill anropa kräver en begärandetext, inkluderar --json och <request-body>ersätter du med begärandetexten <request-body> i JSON-format. Du kan också lagra begärandetexten i en separat JSON-fil. Det gör du genom att --json inkludera @<filename> och <filename>ersätta med JSON-filens namn. Information om hur du hämtar rätt syntax för begärandetexten som du vill inkludera finns i dokumentationen för Databricks REST API.

Exempel

Hämta listan över tillgängliga kluster på arbetsytan.

databricks api get /api/2.0/clusters/list

Hämta information om det angivna klustret på arbetsytan.

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

Uppdatera inställningarna för det angivna klustret på arbetsytan.

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"
}'

Uppdatera inställningarna för det angivna klustret på arbetsytan. Hämta begärandetexten från en fil med namnet edit-cluster.json i den aktuella arbetskatalogen.

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"
}