List Anti-affinity Groups

GET /anti-affinity-group

Responses

  • 200 application/json

    200

    Hide response attribute Show response attribute object
    • Anti-affinity Group

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

        Anti-affinity Group ID

      • name string

        Anti-affinity Group name

        Minimum length is 1, maximum length is 255.

      • Anti-affinity Group description

        Maximum length is 255.

      • instances array[object]

        Instance

        Hide instances attributes Show instances attributes object
        • Anti-affinity Group

          Anti-affinity Group

        • Instance public IP assignment

          Values are inet4, dual, or none.

        • labels object

          Resource labels

          Hide labels attributes Show labels attributes
        • security-groups array[object]

          Security Group

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

            Security Group ID

          • name string

            Security Group name

            Minimum length is 1, maximum length is 255.

          • Security Group description

            Maximum length is 255.

          • external-sources array[string]

            Security Group external sources

        • elastic-ips array[object]

          Elastic IP

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

            Elastic IP ID

          • ip string

            Elastic IP address

          • Elastic IP address family

            Values are inet4 or inet6.

          • cidr string

            Elastic IP cidr

          • Elastic IP description

            Maximum length is 255.

          • Elastic IP healthcheck

            Hide healthcheck attributes Show healthcheck attributes
            • strikes-ok integer(int64)

              Number of attempts before considering the target healthy (default: 2)

              Minimum value is 1, maximum value is 20.

            • Skip TLS verification

            • tls-sni string

              An optional domain or subdomain to check TLS against

              Minimum length is 1, maximum length is 255.

            • strikes-fail integer(int64)

              Number of attempts before considering the target unhealthy (default: 3)

              Minimum value is 1, maximum value is 20.

            • mode string Required

              Health check mode

              Values are tcp, http, or https.

            • port integer(int64) Required

              Health check port

              Minimum value is 1, maximum value is 65535.

            • uri string

              An endpoint to use for the health check, for example '/status'

              Minimum length is 1, maximum length is 255.

            • interval integer(int64)

              Interval between the checks in seconds (default: 10)

              Minimum value is 5, maximum value is 300.

            • timeout integer(int64)

              Health check timeout value in seconds (default: 2)

              Minimum value is 2, maximum value is 60.

          • labels object

            Resource labels

            Hide labels attributes Show labels attributes
        • name string

          Instance name

          Minimum length is 1, maximum length is 255.

        • Instance Type

          Hide instance-type attributes Show instance-type attributes
          • id string(uuid)

            Instance type ID

          • size string

            Instance type size

            Values are large, huge, jumbo, medium, mega, small, extra-large, titan, micro, colossus, or tiny.

          • family string

            Instance type family

            Values are gpu3, gpu2, gpu, memory, storage, standard, colossus, or cpu.

          • cpus integer(int64)

            CPU count

            Minimum value is 0.

          • gpus integer(int64)

            GPU count

            Minimum value is 0.

          • authorized boolean

            Requires authorization or publicly available

          • memory integer(int64)

            Available memory

            Minimum value is 0.

          • zones array[string]

            Instance Type available zones

            Values are ch-dk-2, de-muc-1, ch-gva-2, at-vie-1, de-fra-1, bg-sof-1, or at-vie-2.

        • private-networks array[object]

          Private Network

          Hide private-networks attributes Show private-networks attributes object
        • template object

          Instance Template

          Hide template attributes Show template attributes
          • Template maintainer

          • Template description

            Maximum length is 255.

          • Enable SSH key-based login

          • family string

            Template family

          • name string

            Template name

            Minimum length is 1, maximum length is 255.

          • Template default user

            Minimum length is 1, maximum length is 255.

          • size integer(int64)

            Template size

            Minimum value is 0.

          • Enable password-based login

          • build string

            Template build

          • checksum string

            Template MD5 checksum

          • Boot mode (default: legacy)

            Values are legacy or uefi.

          • id string(uuid)

            Template ID

          • zones array[string]

            Zones availability

            Values are ch-dk-2, de-muc-1, ch-gva-2, at-vie-1, de-fra-1, bg-sof-1, or at-vie-2.

          • url string

            Template source URL

          • version string

            Template version

          • created-at string(date-time)

            Template creation date

          • Template visibility

            Values are private or public.

        • state string

          Instance state

          Values are expunging, starting, destroying, running, stopping, stopped, migrating, error, or destroyed.

        • ssh-key object

          Instance SSH Key

          Hide ssh-key attributes Show ssh-key attributes
          • name string

            SSH key name

            Minimum length is 1, maximum length is 255.

          • SSH key fingerprint

        • Instance Cloud-init user-data (base64 encoded)

          Minimum length is 1.

        • Instance MAC address

        • manager object

          Instance manager

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

            Manager ID

          • type string

            Manager type

            Values are sks-nodepool or instance-pool.

        • Instance Deploy Target

          Hide deploy-target attributes Show deploy-target attributes
          • id string(uuid) Required

            Deploy Target ID

          • name string

            Deploy Target name

            Minimum length is 1, maximum length is 255.

          • type string

            Deploy Target type

            Values are edge or dedicated.

          • Deploy Target description

            Maximum length is 255.

        • Instance IPv6 address

        • id string(uuid)

          Instance ID

        • snapshots array[object]

          Snapshot

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

            Snapshot ID

          • name string

            Snapshot name

            Minimum length is 1, maximum length is 255.

          • created-at string(date-time)

            Snapshot creation date

          • state string

            Snapshot state

            Values are snapshotting, deleted, exporting, ready, deleting, error, or exported.

          • size integer(int64)

            Snapshot size in GiB

            Minimum value is 10, maximum value is 51200.

          • export object

            Exported snapshot information

            Hide export attributes Show export attributes
            • Exported snapshot disk file pre-signed URL

            • md5sum string

              Exported snapshot disk file MD5 checksum

          • instance object

            Compute Instance snapshotted

        • disk-size integer(int64)

          Instance disk size in GiB

          Minimum value is 10, maximum value is 51200.

        • ssh-keys array[object]

          Instance SSH Key

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

            SSH key name

            Minimum length is 1, maximum length is 255.

          • SSH key fingerprint

        • created-at string(date-time)

          Instance creation date

        • public-ip string(ipv4)

          Instance public IPv4 address

GET /anti-affinity-group
curl \
 -X GET https://api-ch-gva-2.exoscale.com/v2/anti-affinity-group
Response examples (200)
{
  "anti-affinity-groups": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "instances": [
        {
          "anti-affinity-groups": [
            {}
          ],
          "public-ip-assignment": "inet4",
          "labels": {
            "key": "string"
          },
          "security-groups": [
            {
              "id": "string",
              "name": "string",
              "description": "string",
              "external-sources": [
                "string"
              ]
            }
          ],
          "elastic-ips": [
            {
              "id": "string",
              "ip": "string",
              "addressfamily": "inet4",
              "cidr": "string",
              "description": "string",
              "healthcheck": {
                "strikes-ok": 42,
                "tls-skip-verify": true,
                "tls-sni": "string",
                "strikes-fail": 42,
                "mode": "tcp",
                "port": 42,
                "uri": "string",
                "interval": 42,
                "timeout": 42
              },
              "labels": {
                "key": "string"
              }
            }
          ],
          "name": "string",
          "instance-type": {
            "id": "string",
            "size": "large",
            "family": "gpu3",
            "cpus": 42,
            "gpus": 42,
            "authorized": true,
            "memory": 42,
            "zones": [
              "ch-dk-2"
            ]
          },
          "private-networks": [
            {
              "id": "string",
              "mac-address": "string"
            }
          ],
          "template": {
            "maintainer": "string",
            "description": "string",
            "ssh-key-enabled": true,
            "family": "string",
            "name": "string",
            "default-user": "string",
            "size": 42,
            "password-enabled": true,
            "build": "string",
            "checksum": "string",
            "boot-mode": "legacy",
            "id": "string",
            "zones": [
              "ch-dk-2"
            ],
            "url": "string",
            "version": "string",
            "created-at": "2024-05-04T09:42:00+00:00",
            "visibility": "private"
          },
          "state": "expunging",
          "ssh-key": {
            "name": "string",
            "fingerprint": "string"
          },
          "user-data": "string",
          "mac-address": "string",
          "manager": {
            "id": "string",
            "type": "sks-nodepool"
          },
          "deploy-target": {
            "id": "string",
            "name": "string",
            "type": "edge",
            "description": "string"
          },
          "ipv6-address": "string",
          "id": "string",
          "snapshots": [
            {
              "id": "string",
              "name": "string",
              "created-at": "2024-05-04T09:42:00+00:00",
              "state": "snapshotting",
              "size": 42,
              "export": {
                "presigned-url": "string",
                "md5sum": "string"
              },
              "instance": {}
            }
          ],
          "disk-size": 42,
          "ssh-keys": [
            {
              "name": "string",
              "fingerprint": "string"
            }
          ],
          "created-at": "2024-05-04T09:42:00+00:00",
          "public-ip": "string"
        }
      ]
    }
  ]
}