CLI des pools d’instances (héritée)

Article
01/31/2025

Important

Cette documentation a été supprimée et peut ne pas être mise à jour.

Ces informations s’appliquent aux versions héritées de Databricks CLI 0.18 et ci-dessous. Databricks vous recommande d’utiliser la version 0.205 ou ultérieure de l’interface CLI Databricks plus récente. Consultez Qu’est-ce que l’interface CLI Databricks ?. Pour rechercher votre version de l’interface CLI Databricks, exécutez databricks -v.

Pour migrer de Databricks CLI version 0.18 ou ultérieure vers Databricks CLI version 0.205 ou ultérieure, consultez migration de l’interface CLI Databricks.

Remarque

L’interface CLI des pools nécessite Databricks CLI 0.9.0 ou version ultérieure.

Vous exécutez des sous-commandes en les ajoutant à databricks instance-pools. Ces sous-commandes appellent l'API des pools d'instances .

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.

Créer un pool d’instances

Pour afficher la documentation sur l’utilisation, exécutez 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": "Standard_D3_v2",
  "min_idle_instances": 10
}

{
  "instance_pool_id": "1234-567890-binds123-pool-abcDe4fG"
}

Supprimer un pool d’instances

Pour afficher la documentation sur l’utilisation, exécutez databricks instance-pools delete --help.

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

Si elle réussit, aucune sortie n’est affichée.

Obtenir des informations sur un pool d’instances

Pour afficher la documentation sur l’utilisation, exécutez 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": 2,
  "node_type_id": "Standard_F16s",
  "idle_instance_autotermination_minutes": 4320,
  "enable_elastic_disk": true,
  "preloaded_spark_versions": [
    "5.5.x-scala2.11"
  ],
  "azure_attributes": {
    "availability": "ON_DEMAND_AZURE"
  },
  "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": 2,
    "pending_used_count": 0,
    "pending_idle_count": 0
  },
  "status": {}
}

Répertorier les informations sur les pools d’instances disponibles

Pour afficher la documentation sur l’utilisation, exécutez databricks instance-pools list --help.

databricks instance-pools list --output JSON

{
  "instance_pools": [
    {
      "instance_pool_name": "My Pool",
      "min_idle_instances": 2,
      "node_type_id": "Standard_F16s",
      "idle_instance_autotermination_minutes": 4320,
      "enable_elastic_disk": true,
      "preloaded_spark_versions": [
        "5.5.x-scala2.11"
      ],
      "azure_attributes": {
        "availability": "ON_DEMAND_AZURE"
      },
      "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": 2,
        "pending_used_count": 0,
        "pending_idle_count": 0
      },
      "status": {}
    },
    ...
  ]
}

Modifier les paramètres d’un pool d’instances

Pour afficher la documentation sur l’utilisation, exécutez 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
}