實例池API 2.0

實例池API允許您創建、編輯、刪除和列出實例池。

實例池通過維護一組空閑的、隨時可用的雲實例來減少集群啟動和自動伸縮時間。當連接到池的集群需要實例時，它首先嚐試分配池的空閑實例之一。如果池沒有空閑實例，它將通過從實例提供程序分配一個新實例進行擴展，以適應集群的請求。當一個集群釋放一個實例時，它將返回到池中，供另一個集群使用。隻有附加到池的集群才能使用該池的空閑實例。

當實例在池中空閑時，Databricks不向DBUs收費。實例提供程序計費不適用。看到定價頁麵。

需求

您必須擁有連接到池的權限;看到池訪問控製．

重要的

要訪問Databricks REST api，必須進行身份驗證．

創建

端點	HTTP方法
`2.0 / instance-pools /創建`	`帖子`

創建實例池。使用返回的instance_pool_id查詢實例池的狀態，包括實例池當前分配的實例數。如果你提供min_idle_instances參數時，實例是在後台準備的，一旦idle_count在InstancePoolStats等於請求的最小值。

請注意

由於實例提供程序限製或瞬時網絡問題，Databricks可能無法獲取一些請求的空閑實例。集群仍然可以附加到實例池，但可能無法快速啟動。

例子

              —netrc -X POST＼https://1234567890123456.7.gcp.www.eheci.com/api/2.0/instance-pools/create＼——數據@create-instance-pool.json
             

create-instance-pool.json：

              ｛“instance_pool_name”：“把遊泳池”，“node_type_id”：“n1-highmem-4”，“min_idle_instances”：10，“custom_tags”：［｛“關鍵”：“我的鑰匙”，“價值”：“自己的價值”｝］｝
             

              ｛“instance_pool_id”：“1234 - 567890 - fetch12池a3bcdefg”｝
             

請求結構

字段名	類型	描述
instance_pool_name	`字符串`	實例池的名稱。這是創建和編輯操作所必需的。必須唯一，非空，且長度小於100個字符。
min_idle_instances	`INT32`	由池維護的空閑實例的最小數目。這是活動集群所使用的任何實例的補充。
max_capacity	`INT32`	池可以包含的最大實例數，包括空閑實例和集群正在使用的實例。一旦達到最大容量，您就不能從池中創建新的集群，現有的集群也不能自動擴展，直到通過集群終止或降級使池中的某些實例空閑。
node_type_id	`字符串`	池中實例的節點類型。連接到池的所有集群繼承此節點類型，池的空閑實例基於此類型分配。方法可以檢索可用節點類型的列表列表節點類型API調用。
custom_tags	的數組ClusterTag	用於實例池資源的附加標記。Databricks除了default_tags之外，還使用這些標記標記所有池資源。 Databricks最多允許43個自定義標記。
gcp_attributes	InstancePoolGCPAttributes	與運行在GCP上的實例池相關的屬性。如果在創建時未指定，則使用一組默認值。

響應結構

字段名	類型	描述
instance_pool_id	`字符串`	創建的實例池ID。

編輯

端點	HTTP方法
`2.0 / instance-pools /編輯`	`帖子`

編輯實例池。這將修改現有實例池的配置。

請注意

說明隻能編輯以下值:instance_pool_name，min_idle_instances,max_capacity．
你必須提供instance_pool_name價值。

例子

              —netrc -X POST＼https://1234567890123456.7.gcp.www.eheci.com/api/2.0/instance-pools/edit＼——數據@edit-instance-pool.json
             

edit-instance-pool.json：

              ｛“instance_pool_id”：“1234 - 567890 - fetch12池a3bcdefg”，“instance_pool_name”：“my-edited-pool”，“min_idle_instances”：5，“max_capacity”：200｝
             

{}

請求結構

字段名	類型	描述
instance_pool_id	`字符串`	要編輯的實例池的ID。該字段為必填項。
instance_pool_name	`字符串`	實例池的名稱。這是創建和編輯操作所必需的。必須唯一，非空，且長度小於100個字符。
min_idle_instances	`INT32`	由池維護的空閑實例的最小數目。這是活動集群所使用的任何實例的補充。
max_capacity	`INT32`	池可以包含的最大實例數，包括空閑實例和集群正在使用的實例。一旦達到最大容量，您就不能從池中創建新的集群，現有的集群也不能自動擴展，直到通過集群終止或降級使池中的某些實例空閑。

刪除

端點	HTTP方法
`2.0 / instance-pools /刪除`	`帖子`

刪除實例池。這將永久地刪除實例池。池中的空閑實例將異步終止。無法將新集群附加到池。連接到池的正在運行的集群將繼續運行，但不能自動擴展。連接到池的終止集群將無法啟動，直到它們被編輯為不再使用池。

例子

              —netrc -X POST＼https://1234567890123456.7.gcp.www.eheci.com/api/2.0/instance-pools/delete＼——數據'{"instance_pool_id": "1234-567890-fetch12-pool-A3BcdEFg"}'
             

{}

請求結構

字段名	類型	描述
instance_pool_id	`字符串`	需要刪除的實例池ID。

得到

端點	HTTP方法
`2.0 / instance-pools /`	`得到`

檢索給定實例池標識符的實例池的信息。

例子

              —netrc -X GET＼https://1234567890123456.7.gcp.www.eheci.com/api/2.0/instance-pools/get＼——數據'{"instance_pool_id": "1234-567890-fetch12-pool-A3BcdEFg"}'
             

              ｛“instance_pool_name”：“把遊泳池”，“min_idle_instances”：10，“max_capacity”：200，“node_type_id”：“n1-highmem-4”，“custom_tags”：｛“我的鑰匙”：“自己的價值”}，“enable_elastic_disk”：假，“instance_pool_id”：“0504 - 170131 - filth3池wwkobw2o”，“default_tags”：｛“供應商”：“磚”，“DatabricksInstancePoolCreatorId”：“1096092131808652”，“DatabricksInstancePoolId”：“0504 - 170131 - filth3池wwkobw2o”}，“狀態”：“活躍”，“統計數據”：{}｝
             

請求結構

字段名	類型	描述
instance_pool_id	`字符串`	要檢索其信息的實例池。

響應結構

字段名	類型	描述
instance_pool_name	`字符串`	實例池的名稱。這是創建和編輯操作所必需的。必須唯一，非空，且長度小於100個字符。
min_idle_instances	`INT32`	由池維護的空閑實例的最小數目。這是活動集群所使用的任何實例的補充。
max_capacity	`INT32`	池可以包含的最大實例數，包括空閑實例和集群正在使用的實例。一旦達到最大容量，您就不能從池中創建新的集群，現有的集群也不能自動擴展，直到通過集群終止或降級使池中的某些實例空閑。
node_type_id	`字符串`	池中實例的節點類型。連接到池的所有集群繼承此節點類型，池的空閑實例基於此類型分配。方法可以檢索可用節點類型的列表列表節點類型API調用。
custom_tags	的數組ClusterTag
instance_pool_id	`字符串`	實例池的規範唯一標識符。
default_tags	的數組ClusterTag	Databricks添加的標簽，不考慮任何custom_tags，包括: 供應商:磚 DatabricksInstancePoolCreatorId: < create_user_id > DatabricksInstancePoolId: < instance_pool_id >
狀態	InstancePoolState	實例池的當前狀態。
統計數據	InstancePoolStats	實例池使用情況的統計信息。

列表

端點	HTTP方法
`2.0 / instance-pools /列表`	`得到`

列出所有實例池的信息。

例子

              —netrc -X GET＼https://1234567890123456.7.gcp.www.eheci.com/api/2.0/instance-pools/list
             

              ｛“instance_pools”：［｛“instance_pool_name”：“把遊泳池”，“min_idle_instances”：10，“max_capacity”：200，“node_type_id”：“n1-highmem-4”，“enable_elastic_disk”：假，“instance_pool_id”：“0504 - 170131 - filth3池wwkobw2o”，“default_tags”：｛“供應商”：“磚”，“DatabricksInstancePoolCreatorId”：“1096092131808652”，“DatabricksInstancePoolId”：“0504 - 170131 - filth3池wwkobw2o”}，“狀態”：“活躍”，“統計數據”：{}}，｛“…”｝］｝
             

響應結構

字段名	類型	描述
instance_pools	的數組InstancePoolAndStats	包含其統計信息的實例池列表。

數據結構

本節:

InstancePoolState

實例池的狀態。當前允許的狀態轉換為:

活躍的->刪除

的名字	描述
活躍的	表示實例池處於活動狀態。集群可以附加到它。
刪除	表示實例池已被刪除，不再可訪問。

InstancePoolStats

實例池使用情況的統計信息。

字段名	類型	描述
used_count	`INT32`	集群正在使用的活動實例的數量。
idle_count	`INT32`	集群未使用的活動實例數。
pending_used_count	`INT32`	分配給集群的掛起實例數。
pending_idle_count	`INT32`	未分配給集群的掛起實例數。

InstancePoolAndStats

字段名	類型	描述
instance_pool_name	`字符串`	實例池的名稱。這是創建和編輯操作所必需的。必須唯一，非空，且長度小於100個字符。
min_idle_instances	`INT32`	由池維護的空閑實例的最小數目。這是活動集群所使用的任何實例的補充。
max_capacity	`INT32`	池可以包含的最大實例數，包括空閑實例和集群正在使用的實例。一旦達到最大容量，您就不能從池中創建新的集群，現有的集群也不能自動擴展，直到通過集群終止或降級使池中的某些實例空閑。
node_type_id	`字符串`	池中實例的節點類型。連接到池的所有集群繼承此節點類型，池的空閑實例基於此類型分配。方法可以檢索可用節點類型的列表列表節點類型API調用。
custom_tags	的數組ClusterTag
enable_elastic_disk	`保齡球`	(本版本不支持)自動伸縮本地存儲:啟用後，池中的實例在磁盤空間不足時動態地獲取額外的磁盤空間。
instance_pool_id	`字符串`	實例池的規範唯一標識符。
default_tags	的數組ClusterTag	Databricks添加的標簽，不考慮任何custom_tags，包括: 供應商:磚 DatabricksInstancePoolCreatorId: < create_user_id > DatabricksInstancePoolId: < instance_pool_id >
狀態	InstancePoolState	實例池的當前狀態。
統計數據	InstancePoolStats	實例池使用情況的統計信息。
gcp_attributes	InstancePoolGCPAttributes	與運行在GCP上的實例池相關的屬性。如果在創建時未指定，則使用一組默認值。

InstancePoolGCPAttributes

創建實例池時設置的與GCP相關的屬性。

字段名	類型	描述
可用性	GcpAvailability	池中所有實例的可用性類型。默認為ON_DEMAND。