Sdílet prostřednictvím

api skupina příkazů

  • Článek

Poznámka:

Tyto informace platí pro Databricks CLI verze 0.205 a vyšší. Rozhraní příkazového řádku Databricks je ve verzi Public Preview.

Použití rozhraní příkazového řádku Databricks podléhá licenci Databricks a oznámení o ochraně osobních údajů Databricks, včetně všech ustanovení o využití.

Skupina api příkazů v rozhraní příkazového řádku Databricks umožňuje volat libovolné dostupné rozhraní REST API Databricks.

Příkaz byste měli spustit api jenom pro pokročilé scénáře, jako jsou verze Preview konkrétních rozhraní DATABricks REST API, pro které rozhraní příkazového řádku Databricks ještě nezabalí cílové rozhraní REST API Databricks v rámci souvisejícího příkazu. Seznam zabalených skupin příkazů najdete v tématu Příkazy rozhraní příkazového řádku Databricks.

Pokud chcete nainstalovat rozhraní příkazového řádku Databricks, přečtěte si téma Instalace nebo aktualizace rozhraní příkazového řádku Databricks. Pokud chcete nakonfigurovat ověřování pro rozhraní příkazového řádku Databricks, přečtěte si téma Ověřování rozhraní příkazového řádku Databricks.

Spouštění api příkazů (pouze pro pokročilé scénáře)

Příkazy spustíte api tak, že je připojíte k databricks apisouboru . Pokud chcete zobrazit nápovědu api k příkazu, spusťte databricks api -hpříkaz .

K volání api příkazu použijte následující formát:

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

V předchozím volání:

  • Nahraďte <http-method> metodou HTTP pro rozhraní REST API Databricks, které chcete volat, například delete, get, head, path, postnebo put. Pokud chcete například vrátit seznam dostupných clusterů pro pracovní prostor, použijte get. Pokud chcete získat správnou metodu HTTP pro rozhraní REST API Databricks, které chcete volat, podívejte se do dokumentace k rozhraní REST API služby Databricks.
  • Nahraďte <rest-api-path> cestou k rozhraní REST API Databricks, které chcete volat. Nezahrnujte https:// ani název instance pracovního prostoru. Pokud chcete například vrátit seznam dostupných clusterů pro pracovní prostor, použijte /api/2.0/clusters/list. Pokud chcete získat správnou syntaxi pro rozhraní REST API Databricks, které chcete volat, podívejte se do dokumentace k rozhraní REST API služby Databricks.
  • Pokud rozhraní Databricks REST API, které chcete volat, vyžaduje text požadavku, včetně --json a <request-body>nahrazení <request-body> textem požadavku ve formátu JSON. Případně můžete text požadavku uložit do samostatného souboru JSON. Chcete-li to provést, zahrňte --json a @<filename>nahraďte <filename> názvem souboru JSON. Pokud chcete získat správnou syntaxi textu požadavku, který chcete zahrnout, podívejte se do dokumentace k rozhraní REST API služby Databricks.

Příklady

Získejte seznam dostupných clusterů v pracovním prostoru.

databricks api get /api/2.0/clusters/list

Získejte informace o zadaném clusteru v pracovním prostoru.

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

Aktualizujte nastavení pro zadaný cluster v pracovním prostoru.

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

Aktualizujte nastavení pro zadaný cluster v pracovním prostoru. Získejte text požadavku ze souboru pojmenovaného edit-cluster.json v aktuálním pracovním adresáři.

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