メインコンテンツまでスキップ

インスタンスプール CLI (レガシー)

important

このドキュメントは廃止されており、更新されない可能性があります。

この情報は、従来の Databricks CLI バージョン 0.18 以下に適用されます。 Databricks では、代わりに新しい Databricks CLI バージョン 0.205 以降を使用することをお勧めします。 「Databricks CLI とは」を参照してください。Databricks CLI のバージョンを確認するには、 databricks -vを実行します。

Databricks CLI バージョン 0.18 以前から Databricks CLI バージョン 0.205 以降に移行するには、「 Databricks CLI の移行」を参照してください。

注記

プール CLI には、Databricks CLI 0.9.0 以降が必要です。

サブコマンドを実行するには、サブコマンドを databricks instance-poolsに追加します。 これらのサブコマンドは、 インスタンス・プール API を呼び出します。

Bash
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.

インスタンス・プールの作成

使用方法のドキュメントを表示するには、 databricks instance-pools create --helpを実行します。

Bash
databricks instance-pools create --json-file create-instance-pool.json

create-instance-pool.json:

JSON
{
"instance_pool_name": "my-pool",
"node_type_id": "i3.xlarge",
"min_idle_instances": 10,
"aws_attributes": {
"availability": "SPOT"
}
}
Console
{
"instance_pool_id": "1234-567890-binds123-pool-abcDe4fG"
}

インスタンス・プールの削除

使用方法のドキュメントを表示するには、 databricks instance-pools delete --helpを実行します。

Bash
databricks instance-pools delete --instance-pool-id 1234-567890-binds123-pool-abcDe4fG

成功した場合、出力は表示されません。

インスタンス・プールに関する情報の取得

使用方法のドキュメントを表示するには、 databricks instance-pools get --helpを実行します。

Bash
databricks instance-pools get --instance-pool-id 1234-567890-binds123-pool-abcDe4fG
Console
{
"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": {}
}

使用可能なインスタンス・プールに関する情報のリスト

使用方法のドキュメントを表示するには、 databricks instance-pools list --helpを実行します。

Bash
databricks instance-pools list --output JSON
Console
{
"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": {}
},
...
]
}

インスタンス・プールの設定を変更する

使用方法のドキュメントを表示するには、 databricks instance-pools edit --helpを実行します。

Bash
databricks instance-pools edit --json-file edit-instance-pool.json

edit-instance-pool.json:

Console
{
"instance_pool_name": "My Pool",
"instance_pool_id": "1234-567890-binds123-pool-abcDe4fG",
"min_idle_instances": 15
}

成功した場合、出力は表示されません。