令牌API 2.0

令牌API允許您創建、列表和撤銷令牌,可用於身份驗證和訪問數據磚REST API。

重要的

訪問數據磚REST api,你必須進行身份驗證

創建

端點

HTTP方法

2.0 /令牌/創建

帖子

創建並返回一個令牌。這個調用返回錯誤QUOTA_EXCEEDED如果當前的非過期的令牌數量超過了令牌的配額。用戶令牌配額是600。

例子

請求

curl——netrc POST請求\https:// < databricks-instance > / api / 2.0 /令牌/創建\——數據{“評論”:“這是一個令牌”、“lifetime_seconds”: 7776000}”\|金橋。

替換:

  • < databricks-instance >與磚工作區實例名例如,dbc-a1b2345c-d6e7.cloud.m.eheci.com

  • 一個例子令牌描述把令牌。

  • 7776000令牌的生命周期,在幾秒鍾內。本例中指定了90天。

這個示例使用. netrc文件和金橋

響應

{“token_value”:“dapi1a2b3c45d67890e1f234567a8bc9012d”,“token_info”:{“token_id”:“1234567890 a12bc3456de789012f34ab56c78d9012e3fabc4de56f7a89b012c3”,“creation_time”:1626286601651,“expiry_time”:1634062601651,“評論”:“這是一個令牌”}}

請求結構

字段名

類型

描述

lifetime_seconds

令牌的生命周期,在幾秒鍾內。如果沒有指定一生,令牌依然無限期有效。

評論

字符串

描述(可選)附加到令牌。

響應結構

字段名

類型

描述

token_value

字符串

的值創建的令牌。

token_info

公共牌信息

的公共元數據創建的令牌。

列表

端點

HTTP方法

2.0 /令牌列表

得到

列出所有有效的令牌為一對用戶工作區。

例子

請求

curl——netrc請求\https:// < databricks-instance > / api / 2.0 /令牌列表\|金橋。

取代< databricks-instance >與磚工作區實例名例如,dbc-a1b2345c-d6e7.cloud.m.eheci.com

這個示例使用. netrc文件和金橋

響應

{“token_infos”:({“token_id”:“1234567890 a12bc3456de789012f34ab56c78d9012e3fabc4de56f7a89b012c3”,“creation_time”:1626286601651,“expiry_time”:1634062601651,“評論”:“這是一個令牌”},{“token_id”:“2345678901 a12bc3456de789012f34ab56c78d9012e3fabc4de56f7a89b012c4”,“creation_time”:1626286906596,“expiry_time”:1634062906596,“評論”:“這是另一個例子令牌”}]}

響應結構

字段名

類型

描述

token_infos

一個數組的公共牌信息

一對用戶工作區的令牌的列表信息。

撤銷

端點

HTTP方法

2.0 /令牌/刪除

帖子

撤銷一個訪問令牌。這個調用返回錯誤RESOURCE_DOES_NOT_EXIST如果一個令牌在指定的ID無效。

例子

curl——netrc POST請求\https:// < databricks-instance > / api / 2.0 /令牌/刪除\——數據”{token_id”:“< token-id >“}”

這個示例使用. netrc文件。

替換:

  • < databricks-instance >與磚工作區實例名例如,dbc-a1b2345c-d6e7.cloud.m.eheci.com

  • < token-id >例如,與標記的ID1234567890 a12bc3456de789012f34ab56c78d9012e3fabc4de56f7a89b012c3

請求結構

字段名

類型

描述

token_id

字符串

標記的ID被撤銷。

數據結構

在本節中:

公共牌信息

一種數據結構,描述了公共元數據的一個訪問令牌。

字段名

類型

描述

token_id

字符串

標記的ID。

creation_time

服務器時間(毫秒)時代令牌時創建的。

expiry_time

服務器時間(毫秒)時代令牌何時到期,如果不適用或1。

評論

字符串

評論創建令牌,如果適用的話。