api
parancscsoport
Feljegyzés
Ezek az információk a Databricks CLI 0.205-ös és újabb verzióira vonatkoznak. A Databricks parancssori felülete nyilvános előzetes verzióban érhető el.
A Databricks CLI használatára a Databricks Licenc és a Databricks adatvédelmi nyilatkozata vonatkozik, beleértve a használati adatokra vonatkozó rendelkezéseket is.
A api
Databricks parancssori felületén található parancscsoport lehetővé teszi az elérhető Databricks REST API meghívását.
A parancsot csak speciális forgatókönyvekhez kell futtatnia api
, például bizonyos Databricks REST API-k előzetes kiadásaihoz, amelyekhez a Databricks PARANCSSOR még nem burkolja a cél Databricks REST API-t egy kapcsolódó parancson belül. A becsomagolt parancscsoportok listáját a Databricks CLI-parancsokcímű témakörben találja.
A Databricks parancssori felületének telepítéséhez lásd: A Databricks parancssori felületének telepítése vagy frissítése. A Databricks parancssori felület hitelesítésének konfigurálásához tekintse meg a Databricks parancssori felület hitelesítését.
Parancsok futtatása api
(csak speciális forgatókönyvekhez)
Parancsokat a parancsok hozzáfűzésével futtathat api
databricks api
. A parancs súgójának megjelenítéséhez futtassa a api
parancsot databricks api -h
.
A parancs meghívásához api
használja a következő formátumot:
databricks api <http-method> <rest-api-path> [--json {<request-body> | @<filename>}]
Az előző hívásban:
- Cserélje le
<http-method>
a meghívni kívánt Databricks REST API HTTP-metódusára, példáuldelete
: ,get
,head
,path
post
vagyput
. Ha például egy munkaterülethez elérhető fürtök listáját szeretné visszaadni, használja aget
. A meghívni kívánt Databricks REST API megfelelő HTTP-metódusának beszerzéséhez tekintse meg a Databricks REST API dokumentációját. - Cserélje le
<rest-api-path>
a meghívni kívánt Databricks REST API elérési útjára. Ne adja meg vagy ne adja meghttps://
a munkaterület-példány nevét. Például, ha szeretné megjeleníteni a munkaterülethez elérhető fürtök listáját, használja a/api/2.0/clusters/list
. A meghívni kívánt Databricks REST API helyes szintaxisának lekéréséhez tekintse meg a Databricks REST API dokumentációját. - Ha a meghívni kívánt Databricks REST API-hoz kérelemtörzsre van szükség, írja be
--json
és<request-body>
cserélje le<request-body>
a kérelem törzsét JSON formátumban. Másik lehetőségként a kérelem törzsét külön JSON-fájlban is tárolhatja. Ehhez vegye fel--json
és@<filename>
cserélje le<filename>
a JSON-fájl nevét. A belefoglalni kívánt kérelemtörzs megfelelő szintaxisának lekéréséhez tekintse meg a Databricks REST API dokumentációját.
Példák
Kérje le a munkaterületen elérhető fürtök listáját.
databricks api get /api/2.0/clusters/list
A munkaterületen megadott fürt információinak megtekintése.
databricks api post /api/2.0/clusters/get --json '{
"cluster_id": "1234-567890-abcde123"
}'
Módosítsa a megadott fürt beállításait a munkaterületen.
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"
}'
Frissítse a megadott klaszter beállításait a munkaterületen. Kérje le a kérelem törzsét egy edit-cluster.json
nevű fájlból az aktuális munkakönyvtárban.
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"
}