实例池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.neidfyre.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.neidfyre.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.neidfyre.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.neidfyre.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.neidfyre.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。