api skupina příkazů

Note

Tyto informace platí pro Databricks CLI verze 0.205 a vyšší. Rozhraní příkazového řádku Databricks je ve veřejné ukázce.

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 api byste měli spustit pouze pro pokročilé scénáře, jako jsou verze náhledů konkrétních rozhraní Databricks REST API, pro které Databricks CLI neobsahuje již příslušný příkaz pro cílené rozhraní Databricks REST API. Seznam skupin příkazů najdete v tématu Příkazy rozhraní příkazového řádku Databricks.

Odstranění rozhraní API databricks

Provedení požadavku DELETE

databricks api delete PATH [flags]

Arguments

PATH

    Cesta ke koncovému bodu rozhraní API

Možnosti

--json JSON

    Vložený řetězec JSON nebo soubor JSON @path s tělem požadavku

Globální příznaky

Examples

databricks api delete /api/2.0/jobs/runs/delete --json '{"run_id": 123}'

Načtení API Databricks

Provedení GET požadavku

databricks api get PATH [flags]

Arguments

PATH

    Cesta ke koncovému bodu rozhraní API

Možnosti

--json JSON

    Vložený řetězec JSON nebo soubor JSON @path s tělem požadavku

Globální příznaky

Examples

Následující příklad získá seznam dostupných clusterů v pracovním prostoru:

databricks api get /api/2.0/clusters/list

Následující příklad získá úlohu:

databricks api get /api/2.0/jobs/get --json '{"job_id": 123}'

Hlavička rozhraní API databricks

Provedení požadavku HEAD

databricks api head PATH [flags]

Arguments

PATH

    Cesta ke koncovému bodu rozhraní API

Možnosti

--json JSON

    Vložený řetězec JSON nebo soubor JSON @path s tělem požadavku

Globální příznaky

Examples

databricks api head /api/2.0/clusters/list

Oprava rozhraní API databricks

Proveďte požadavek PATCH

databricks api patch PATH [flags]

Arguments

PATH

    Cesta ke koncovému bodu rozhraní API

Možnosti

--json JSON

    Vložený řetězec JSON nebo soubor JSON @path s tělem požadavku

Globální příznaky

Examples

databricks api patch /api/2.0/jobs/update --json '{"job_id": 123, "new_settings": {"name": "Updated Job"}}'

Post rozhraní API databricks

Provedení požadavku POST

databricks api post PATH [flags]

Arguments

PATH

    Cesta ke koncovému bodu rozhraní API

Možnosti

--json JSON

    Vložený řetězec JSON nebo soubor JSON @path s tělem požadavku

Globální příznaky

Examples

Následující příklad získá informace o zadaném clusteru v pracovním prostoru.

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

Následující příklad vytvoří cluster:

databricks api post /api/2.0/clusters/create --json '{"cluster_name": "test-cluster", "spark_version": "11.3.x-scala2.12"}'

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 s názvem 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"
}

Databricks API put

Provedení požadavku PUT

databricks api put PATH [flags]

Arguments

PATH

    Cesta ke koncovému bodu rozhraní API

Možnosti

--json JSON

    Vložený řetězec JSON nebo soubor JSON @path s tělem požadavku

Globální příznaky

Examples

databricks api put /api/2.0/workspace/import --json @workspace-import.json

Globální příznaky

--debug

  Zda povolit protokolování ladění.

-h nebo --help

    Zobrazení nápovědy k rozhraní příkazového řádku Databricks nebo související skupině příkazů nebo souvisejícímu příkazu

--log-file řetězec

    Řetězec představující soubor, do kterého se zapisují výstupní protokoly. Pokud tento příznak není zadaný, výchozí hodnota je zápis výstupních protokolů do stderru.

--log-format formát

    Typ formátu protokolu, text nebo json. Výchozí hodnota je text.

--log-level řetězec

    Řetězec představující úroveň formátu protokolu. Pokud není zadána, je úroveň formátu protokolu zakázaná.

-o, --output typ

    Typ výstupu příkazu, text nebo json. Výchozí hodnota je text.

-p, --profile řetězec

    Název profilu v ~/.databrickscfg souboru, který se má použít ke spuštění příkazu. Pokud tento příznak není zadán, použije se profil s názvem DEFAULT, pokud existuje.

--progress-format formát

    Formát pro zobrazení protokolů průběhu: default, append, inplacenebo json

-t, --target řetězec

    Pokud je to relevantní, cílový balíček, který se má použít