Instance Pools CLI (legacy)
Important
This documentation has been retired and might not be updated.
This information applies to legacy Databricks CLI versions 0.18 and below. Databricks recommends that you use newer Databricks CLI version 0.205 or above instead. See What is the Databricks CLI?. To find your version of the Databricks CLI, run databricks -v
.
To migrate from Databricks CLI version 0.18 or below to Databricks CLI version 0.205 or above, see Databricks CLI migration.
Note
The pools CLI requires Databricks CLI 0.9.0 or above.
You run subcommands by appending them to databricks instance-pools
. These subcommands call the Instance Pools API.
databricks instance-pools -h
Usage: databricks instance-pools [OPTIONS] COMMAND [ARGS]...
Utility to interact with Databricks instance pools.
Options:
-v, --version [VERSION]
-h, --help Show this message and exit.
Commands:
create Creates a Databricks instance pool.
Options:
--json-file PATH File containing JSON request to POST to /api/2.0/cluster-pools/create.
--json JSON JSON string to POST to /api/2.0/cluster-pools/create.
delete Deletes a Databricks instance pool.
Options:
get Retrieves metadata about an instance pool.
Options:
--instance-pool-id INSTANCE_POOL_ID Can be found in the URL at https://<databricks-instance>/?o=<16-digit-number>#/setting/clusters/instance-pools/view/$INSTANCE_POOL_ID.
list Lists active instance pools with the stats of the pools.
Options:
--output FORMAT JSON or TABLE. Set to TABLE by default.
edit Edits a Databricks instance pool
Options:
--json-file PATH File containing JSON request to POST to /api/2.0/cluster-pools/create.
--json JSON JSON string to POST to /api/2.0/cluster-pools/create.
Create an instance pool
To display usage documentation, run databricks instance-pools create --help
.
databricks instance-pools create --json-file create-instance-pool.json
create-instance-pool.json
:
{
"instance_pool_name": "my-pool",
"node_type_id": "i3.xlarge",
"min_idle_instances": 10,
"aws_attributes": {
"availability": "SPOT"
}
}
{
"instance_pool_id": "1234-567890-binds123-pool-abcDe4fG"
}
Delete an instance pool
To display usage documentation, run databricks instance-pools delete --help
.
databricks instance-pools delete --instance-pool-id 1234-567890-binds123-pool-abcDe4fG
If successful, no output is displayed.
Get information about an instance pool
To display usage documentation, run databricks instance-pools get --help
.
databricks instance-pools get --instance-pool-id 1234-567890-binds123-pool-abcDe4fG
{
"instance_pool_name": "My Pool",
"min_idle_instances": 0,
"max_capacity": 10,
"aws_attributes": {
"availability": "SPOT",
"zone_id": "us-west-2c",
"spot_bid_price_percent": 100
},
"node_type_id": "i3.xlarge",
"idle_instance_autotermination_minutes": 0,
"enable_elastic_disk": false,
"instance_pool_id": "1234-567890-binds123-pool-abcDe4fG",
"default_tags": {
"Vendor": "Databricks",
"DatabricksInstancePoolCreatorId": "123456789012345",
"DatabricksInstancePoolId": "1234-567890-binds123-pool-abcDe4fG",
"DatabricksInstanceGroupId": "-2345678901234567890"
},
"state": "ACTIVE",
"stats": {
"used_count": 0,
"idle_count": 0,
"pending_used_count": 0,
"pending_idle_count": 0
},
"status": {}
}
List information about available instance pools
To display usage documentation, run databricks instance-pools list --help
.
databricks instance-pools list --output JSON
{
"instance_pools": [
{
"instance_pool_name": "My Pool",
"min_idle_instances": 0,
"max_capacity": 10,
"aws_attributes": {
"availability": "SPOT",
"zone_id": "us-west-2c",
"spot_bid_price_percent": 100
},
"node_type_id": "i3.xlarge",
"idle_instance_autotermination_minutes": 0,
"enable_elastic_disk": false,
"instance_pool_id": "1234-567890-binds123-pool-abcDe4fG",
"default_tags": {
"Vendor": "Databricks",
"DatabricksInstancePoolCreatorId": "123456789012345",
"DatabricksInstancePoolId": "1234-567890-binds123-pool-abcDe4fG",
"DatabricksInstanceGroupId": "-2345678901234567890"
},
"state": "ACTIVE",
"stats": {
"used_count": 0,
"idle_count": 0,
"pending_used_count": 0,
"pending_idle_count": 0
},
"status": {}
},
...
]
}
Change the settings of an instance pool
To display usage documentation, run databricks instance-pools edit --help
.
databricks instance-pools edit --json-file edit-instance-pool.json
edit-instance-pool.json
:
{
"instance_pool_name": "My Pool",
"instance_pool_id": "1234-567890-binds123-pool-abcDe4fG",
"min_idle_instances": 15
}
If successful, no output is displayed.