api命令组
请注意
这个信息适用于砖CLI 0.200及以上版本,在公共预览。找到你的版本的砖CLI,运行砖- v。
的api命令组内砖CLI使您能够调用任何可用的砖REST API。
你应该跑api命令只有在高级场景,比如预览版本的具体砖砖的REST API的CLI尚未包装中的目标砖REST API的相关命令。包装命令组的列表,请参阅CLI命令组。
重要的
在您使用砖CLI之前,一定要设置数据砖CLI和设置身份验证数据砖CLI。
运行api命令(仅供高级场景)
你跑api通过添加他们的命令砖api。显示帮助api命令,运行砖api- h。
调用api命令,使用以下格式:
砖api < http方法> < rest-api-path > [- json{<请求体> | @ <文件名>}]
在前面的电话:
取代
< http方法>与砖的HTTP方法你想调用REST API,如删除,得到,头,路径,帖子,或把。例如,返回的列表可用集群工作空间,使用得到。得到正确的HTTP方法砖你想调用REST API,看到砖REST API文档。取代
< rest-api-path >与砖的路径你想调用REST API。不包括https://或工作区实例名。例如,返回的列表可用集群工作空间,使用. . / api / 2.0 /集群列表中。得到正确的语法砖你想调用REST API,看到砖REST API文档。如果你想调用的砖REST API的需要请求主体,包括
——json和<请求体>,替换<请求体>JSON格式的请求主体。或者,您可以存储在一个单独的JSON文件请求主体。要做到这一点,包括——json和@ <文件名>,替换<文件名>JSON文件的名字。得到正确的语法对于你想要包括的请求主体,看到砖REST API文档。
与砖工作区进行身份验证api命令总是按照以下顺序搜索身份验证信息,阻止其搜索后,发现它所需要的:
的
DATABRICKS_HOST和DATABRICKS_TOKEN环境变量。的
DATABRICKS_HOST,DATABRICKS_USERNAME,DATABRICKS_PASSWORD环境变量。的
默认的概要文件在你的.databrickscfg文件。这个概要文件必须包含的主机和令牌字段或主机,用户名,密码字段。
与砖账户而不是工作区,进行身份验证api命令总是按照以下顺序搜索身份验证信息,阻止其搜索后,发现它所需要的:
的
DATABRICKS_HOST,DATABRICKS_USERNAME,DATABRICKS_PASSWORD,DATABRICKS_ACCOUNT_ID环境变量。的
默认的概要文件在你的.databrickscfg文件。这个概要文件必须包含主机,用户名,密码,account_id字段。
如果api仍然找不到所需的身份验证信息,api命令失败。的api命令(和所有其他命令)支持——简介选择指定以外的一个概要文件默认的一个。
请注意
的api命令不使用OAuth身份验证。
例子
在工作区中可用的集群列表。
砖api得到. . / api / 2.0 /集群列表中
在工作区中获取指定集群的信息。
砖api post . . / api / 2.0 /集群/ get - json”{“cluster_id”:“1234 - 567890 abcde123”}'
在工作区中更新设置为指定的集群。
砖api的帖子. . / api / 2.0 /集群/编辑——json”{“cluster_id”:“1234 - 567890 abcde123”,:“cluster_name my-changed-cluster”,“num_workers”: 1、:“spark_version 11.3.x-scala2.12”,:“node_type_id i3.xlarge”}'
在工作区中更新设置为指定的集群。从一个文件名为获取请求主体edit-cluster.json在当前工作目录。
砖api的帖子. . / api / 2.0 /集群/编辑——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”:“i3.xlarge”}