GET /instance-pool

Responses

  • 200 application/json

    200

    Hide response attribute Show response attribute object
    • instance-pools array[object]

      Instance Pool

      Hide instance-pools attributes Show instance-pools attributes object
      • application-consistent-snapshot-enabled boolean

        Enable application consistent snapshots

      • anti-affinity-groups array[object]

        Instance Pool Anti-affinity Groups

        Anti-affinity group reference

        Hide anti-affinity-groups attribute Show anti-affinity-groups attribute object
        • id string(uuid)

          Anti-affinity group ID

      • description string

        Instance Pool description

        Minimum length is 1, maximum length is 255.

      • public-ip-assignment string

        Values are inet4, dual, or none.

      • labels object
        Hide labels attribute Show labels attribute object
        • * string Additional properties
      • security-groups array[object]

        Instance Pool Security Groups

        Security group reference

        Hide security-groups attribute Show security-groups attribute object
        • id string(uuid)

          Security group ID

      • elastic-ips array[object]

        Instances Elastic IPs

        Elastic IP reference

        Hide elastic-ips attribute Show elastic-ips attribute object
        • id string(uuid)

          Elastic IP ID

      • name string

        Instance Pool name

        Minimum length is 1, maximum length is 255.

      • instance-type object

        Instance type reference

        Hide instance-type attribute Show instance-type attribute object
        • id string(uuid)

          Instance type ID

      • min-available integer(int64)

        Minimum number of running instances

        Minimum value is 0.

      • private-networks array[object]

        Instance Pool Private Networks

        Private network reference

        Hide private-networks attribute Show private-networks attribute object
        • id string(uuid)

          Private network ID

      • template object

        Template reference

        Hide template attribute Show template attribute object
        • id string(uuid)

          Template ID

      • state string

        Instance Pool state

        Values are scaling-up, scaling-down, destroying, creating, suspended, running, or updating.

      • size integer(int64)

        Number of instances

        Minimum value is 0.

      • ssh-key object

        SSH key reference

        Hide ssh-key attribute Show ssh-key attribute object
        • name string

          SSH key name

          Minimum length is 1, maximum length is 255.

      • instance-prefix string

        The instances created by the Instance Pool will be prefixed with this value (default: pool)

        Minimum length is 1, maximum length is 30.

      • user-data string

        Instances Cloud-init user-data

        Minimum length is 1.

      • manager object

        Resource manager

        Hide manager attributes Show manager attributes object
        • id string(uuid)

          Manager ID

        • type string

          Manager type

          Values are sks-nodepool or instance-pool.

      • instances array[object]

        Instances

        Target Instance

        Hide instances attribute Show instances attribute object
        • id string(uuid)

          Instance ID

      • deploy-target object

        Deploy target reference

        Hide deploy-target attribute Show deploy-target attribute object
        • id string(uuid)

          Deploy target ID

      • ipv6-enabled boolean

        Enable IPv6 for instances

      • id string(uuid)

        Instance Pool ID

      • disk-size integer(int64)

        Instances disk size in GiB

        Minimum value is 10, maximum value is 51200.

      • ssh-keys array[object]

        Instances SSH keys

        SSH key reference

        Hide ssh-keys attribute Show ssh-keys attribute object
        • name string

          SSH key name

          Minimum length is 1, maximum length is 255.
GET /instance-pool 
curl \
 --request GET 'https://api-ch-gva-2.exoscale.com/v2/instance-pool'
Response examples (200) 
{
  "instance-pools": [
    {
      "application-consistent-snapshot-enabled": true,
      "anti-affinity-groups": [
        {
          "id": "string"
        }
      ],
      "description": "string",
      "public-ip-assignment": "inet4",
      "labels": {
        "additionalProperty1": "string",
        "additionalProperty2": "string"
      },
      "security-groups": [
        {
          "id": "string"
        }
      ],
      "elastic-ips": [
        {
          "id": "string"
        }
      ],
      "name": "string",
      "instance-type": {
        "id": "string"
      },
      "min-available": 42,
      "private-networks": [
        {
          "id": "string"
        }
      ],
      "template": {
        "id": "string"
      },
      "state": "scaling-up",
      "size": 42,
      "ssh-key": {
        "name": "string"
      },
      "instance-prefix": "string",
      "user-data": "string",
      "manager": {
        "id": "string",
        "type": "sks-nodepool"
      },
      "instances": [
        {
          "id": "string"
        }
      ],
      "deploy-target": {
        "id": "string"
      },
      "ipv6-enabled": true,
      "id": "string",
      "disk-size": 42,
      "ssh-keys": [
        {
          "name": "string"
        }
      ]
    }
  ]
}