api grupa poleceń

Note

Korzystanie z interfejsu wiersza polecenia usługi Databricks podlega licencjom usługi Databricks i powiadomieniom o ochronie prywatności usługi Databricks, w tym wszelkim przepisom dotyczącym danych użycia.

Grupa api poleceń w interfejsie wiersza polecenia usługi Databricks umożliwia wywoływanie dowolnego dostępnego interfejsu API REST usługi Databricks.

Należy uruchomić api polecenie tylko w przypadku zaawansowanych scenariuszy, takich jak wersje zapoznawcze określonych interfejsów API REST usługi Databricks, dla których interfejs wiersza polecenia usługi Databricks nie opakowuje jeszcze docelowego interfejsu API REST usługi Databricks w powiązanym poleceniu. Aby uzyskać listę grup poleceń, zobacz Polecenia Databricks CLI.

usuwanie interfejsu API usługi databricks

Wykonywanie żądania DELETE

databricks api delete PATH [flags]

Arguments

PATH

    Ścieżka punktu końcowego interfejsu API

Opcje

--json JSON

    Wbudowany ciąg JSON lub @path do pliku JSON z treścią żądania

Flagi globalne

Examples

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

wywołanie API Databricks

Wykonywanie GET żądania

databricks api get PATH [flags]

Arguments

PATH

    Ścieżka punktu końcowego interfejsu API

Opcje

--json JSON

    Wbudowany ciąg JSON lub @path do pliku JSON z treścią żądania

Flagi globalne

Examples

Poniższy przykład pobiera listę dostępnych klastrów w obszarze roboczym:

databricks api get /api/2.0/clusters/list

Poniższy przykład wykonuje zadanie:

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

szef interfejsu API usługi databricks

Wykonywanie żądania HEAD

databricks api head PATH [flags]

Arguments

PATH

    Ścieżka punktu końcowego interfejsu API

Opcje

--json JSON

    Wbudowany ciąg JSON lub @path do pliku JSON z treścią żądania

Flagi globalne

Examples

databricks api head /api/2.0/clusters/list

Poprawka interfejsu API usługi databricks

Wykonywanie żądania PATCH

databricks api patch PATH [flags]

Arguments

PATH

    Ścieżka punktu końcowego interfejsu API

Opcje

--json JSON

    Wbudowany ciąg JSON lub @path do pliku JSON z treścią żądania

Flagi globalne

Examples

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

post interfejsu API usługi databricks

Wykonywanie żądania POST

databricks api post PATH [flags]

Arguments

PATH

    Ścieżka punktu końcowego interfejsu API

Opcje

--json JSON

    Wbudowany ciąg JSON lub @path do pliku JSON z treścią żądania

Flagi globalne

Examples

Poniższy przykład pobiera informacje o określonym klastrze w obszarze roboczym.

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

Poniższy przykład tworzy klaster:

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

Zaktualizuj ustawienia określonego klastra w obszarze roboczym.

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

Zaktualizuj ustawienia określonego klastra w obszarze roboczym. Pobierz treść żądania z pliku o nazwie edit-cluster.json w bieżącym katalogu roboczym.

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

umieszczanie interfejsu API usługi databricks

Wykonywanie żądania PUT

databricks api put PATH [flags]

Arguments

PATH

    Ścieżka punktu końcowego interfejsu API

Opcje

--json JSON

    Wbudowany ciąg JSON lub @path do pliku JSON z treścią żądania

Flagi globalne

Examples

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

Flagi globalne

--debug

  Czy włączyć logowanie debugowe.

-h lub --help

    Wyświetl pomoc dla Databricks CLI lub dla powiązanej grupy poleceń czy pojedynczego polecenia.

--log-file struna

    Ciąg reprezentujący plik do zapisywania dzienników wyjściowych. Jeśli ta flaga nie zostanie określona, wartością domyślną jest zapisywanie dzienników wyjściowych w programie stderr.

--log-format formatowanie

    Format typu logu text lub json. Wartość domyślna to text.

--log-level struna

    Ciąg reprezentujący poziom formatu zapisu dziennika. Jeśli nie zostanie określony, poziom formatu dziennika jest wyłączony.

-o, --output typ

    Typ danych wyjściowych polecenia: text lub json. Wartość domyślna to text.

-p, --profile struna

    Nazwa profilu pliku ~/.databrickscfg, którego użyć do uruchomienia polecenia. Jeśli ta flaga nie zostanie określona, zostanie użyty profil o nazwie DEFAULT .

--progress-format formatowanie

    Format wyświetlania dzienników postępu: default, , appendinplacelubjson

-t, --target struna

    Jeśli ma to zastosowanie, docelowy obiekt pakietu do użycia