Udostępnij za pośrednictwem

api grupa poleceń

  • Artykuł

Uwaga

Te informacje dotyczą interfejsu wiersza polecenia usługi Databricks w wersji 0.205 lub nowszej. Interfejs wiersza polecenia usługi Databricks jest w publicznej wersji zapoznawczej.

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ę opakowanych grup poleceń, zobacz Polecenia interfejsu wiersza polecenia usługi Databricks.

Aby zainstalować interfejs wiersza polecenia usługi Databricks, zobacz Instalowanie lub aktualizowanie interfejsu wiersza polecenia usługi Databricks. Aby skonfigurować uwierzytelnianie dla interfejsu wiersza polecenia usługi Databricks, zobacz Uwierzytelnianie dla interfejsu wiersza polecenia usługi Databricks.

Uruchamianie api poleceń (tylko w przypadku zaawansowanych scenariuszy)

api Uruchamiasz polecenia, dołączając je do databricks apielementu . Aby wyświetlić pomoc dotyczącą api polecenia, uruchom polecenie databricks api -h.

Aby wywołać api polecenie, użyj następującego formatu:

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

W poprzednim wywołaniu:

  • Zastąp <http-method> ciąg metodą HTTP interfejsu API REST usługi Databricks, który chcesz wywołać, na przykład delete, , gethead, path, , postlub put. Aby na przykład zwrócić listę dostępnych klastrów dla obszaru roboczego, użyj polecenia get. Aby uzyskać poprawną metodę HTTP dla interfejsu API REST usługi Databricks, który chcesz wywołać, zobacz dokumentację interfejsu API REST usługi Databricks.
  • Zastąp <rest-api-path> ciąg ścieżką do interfejsu API REST usługi Databricks, który chcesz wywołać. Nie dołączaj https:// ani nazwy wystąpienia obszaru roboczego. Aby na przykład zwrócić listę dostępnych klastrów dla obszaru roboczego, użyj polecenia /api/2.0/clusters/list. Aby uzyskać poprawną składnię interfejsu API REST usługi Databricks, który chcesz wywołać, zobacz dokumentację interfejsu API REST usługi Databricks.
  • Jeśli interfejs API REST usługi Databricks, który chcesz wywołać, wymaga treści żądania, dołącz --json element i <request-body>, zastępując <request-body> element treścią żądania w formacie JSON. Alternatywnie można przechowywać treść żądania w osobnym pliku JSON. W tym celu uwzględnij --json wartości i @<filename>, zastępując <filename> ciąg nazwą pliku JSON. Aby uzyskać poprawną składnię treści żądania, którą chcesz uwzględnić, zobacz dokumentację interfejsu API REST usługi Databricks.

Przykłady

Pobierz listę dostępnych klastrów w obszarze roboczym.

databricks api get /api/2.0/clusters/list

Uzyskaj informacje o określonym klastrze w obszarze roboczym.

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

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