Delen via

api opdrachtgroep

  • Artikel

Notitie

Deze informatie is van toepassing op Databricks CLI-versies 0.205 en hoger. De Databricks CLI bevindt zich in openbare preview.

Databricks CLI-gebruik is onderhevig aan de Databricks-licentie en de privacyverklaring van Databricks, met inbegrip van alle bepalingen voor gebruiksgegevens.

api Met de opdrachtgroep in de Databricks CLI kunt u alle beschikbare Databricks REST API aanroepen.

U moet de api opdracht alleen uitvoeren voor geavanceerde scenario's, zoals preview-versies van specifieke Databricks REST API's waarvoor de Databricks CLI de Databricks REST API nog niet verpakt binnen een gerelateerde opdracht. Zie Databricks CLI-opdrachtenvoor een lijst met verpakte opdrachtgroepen.

Zie Installatie of update van de Databricks CLIvoor instructies over het installeren van de Databricks CLI. Zie Verificatie voor de Databricks CLI om verificatie voor de Databricks CLI te configureren.

Opdrachten uitvoeren api (alleen voor geavanceerde scenario's)

U voert opdrachten uit api door ze toe te voegen aan databricks api. Als u help voor de api opdracht wilt weergeven, voert u het volgende uit databricks api -h.

Gebruik de volgende indeling om de api opdracht aan te roepen:

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

In de voorgaande aanroep:

  • Vervang <http-method> door de HTTP-methode voor de Databricks REST API die u wilt aanroepen, zoals delete, get, head, path, , of postput. Als u bijvoorbeeld de lijst met beschikbare clusters voor een werkruimte wilt retourneren, gebruikt u get. Als u de juiste HTTP-methode wilt ophalen voor de Databricks REST API die u wilt aanroepen, raadpleegt u de Databricks REST API-documentatie.
  • Vervang <rest-api-path> door het pad naar de Databricks REST API die u wilt aanroepen. Neem de naam van het werkruimte-exemplaar niet op https:// . Als u bijvoorbeeld de lijst met beschikbare clusters voor een werkruimte wilt retourneren, gebruikt u /api/2.0/clusters/list. Als u de juiste syntaxis wilt ophalen voor de Databricks REST API die u wilt aanroepen, raadpleegt u de Databricks REST API-documentatie.
  • Als voor de Databricks REST API die u wilt aanroepen een aanvraagbody is vereist, neemt u deze op --json en <request-body>vervangt u deze door <request-body> de aanvraagbody in JSON-indeling. U kunt de aanvraagbody ook opslaan in een afzonderlijk JSON-bestand. Hiervoor moet u de naam van het JSON-bestand opnemen --json en @<filename>vervangen <filename> door de naam van het JSON-bestand. Als u de juiste syntaxis wilt ophalen voor de aanvraagbody die u wilt opnemen, raadpleegt u de Databricks REST API-documentatie.

Voorbeelden

Haal de lijst met beschikbare clusters in de werkruimte op.

databricks api get /api/2.0/clusters/list

Informatie ophalen over het opgegeven cluster in de werkruimte.

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

Instellingen voor het opgegeven cluster in de werkruimte bijwerken.

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

Instellingen voor het opgegeven cluster in de werkruimte bijwerken. Haal de hoofdtekst van de aanvraag op uit een bestand met de naam edit-cluster.json in de huidige werkmap.

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