Anti-Affinity Group

Anti-Affinity Group

Anti-affinity groups let you define placement constraints for your Compute instances.

Read more

create-anti-affinity-group

Create an Anti-affinity Group

POST /anti-affinity-group

Request body

Content-Type: application/json

PropertyTypeRequiredDescription
namestringyesAnti-affinity Group name
descriptionstringnoAnti-affinity Group description
Example
{
  "description": "string",
  "name": "string"
}

Responses

Status: 200 - 200

Content-Type: application/json

PropertyTypeDescription
idstringOperation ID
messagestringOperation message
reasonstringOperation failure reason

Allowed values: incorrect, unknown, unavailable, forbidden, busy, fault, partial, not-found, interrupted, unsupported, conflict.
referenceobjectRelated resource reference schema details
statestringOperation status

Allowed values: failure, pending, success, timeout.
Example output
{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for create-anti-affinity-group: golang | Python | Java

CLI: exo api create-anti-affinity-group

get-anti-affinity-group

Retrieve Anti-affinity Group details

GET /anti-affinity-group/{id}

Path parameters

NameInDescription
idpath

Responses

Status: 200 - 200

Content-Type: application/json

PropertyTypeDescription
descriptionstringAnti-affinity Group description
idstringAnti-affinity Group ID
instancesarray[object]Anti-affinity Group instances schema details
namestringAnti-affinity Group name
Example output
{
  "description": "string",
  "id": "string",
  "instances": [
    {
      "anti-affinity-groups": [
        {
          "description": "string",
          "id": "string",
          "instances": [
            null
          ],
          "name": "string"
        }
      ],
      "application-consistent-snapshot-enabled": true,
      "created-at": "2024-01-01T12:00:00Z",
      "deploy-target": {
        "description": "string",
        "id": "string",
        "name": "string",
        "type": "edge"
      },
      "disk-size": 0,
      "elastic-ips": [
        {
          "addressfamily": "inet4",
          "cidr": "string",
          "description": "string",
          "healthcheck": {
            "interval": null,
            "mode": null,
            "port": null,
            "strikes-fail": null,
            "strikes-ok": null,
            "timeout": null,
            "tls-skip-verify": null,
            "tls-sni": null,
            "uri": null
          },
          "id": "string",
          "ip": "string",
          "labels": {}
        }
      ],
      "id": "string",
      "instance-type": {
        "authorized": true,
        "cpus": 0,
        "family": "gpu3",
        "gpus": 0,
        "id": "string",
        "memory": 0,
        "size": "large",
        "zones": [
          "ch-dk-2"
        ]
      },
      "ipv6-address": "string",
      "labels": {},
      "mac-address": "string",
      "manager": {
        "id": "string",
        "type": "sks-nodepool"
      },
      "name": "string",
      "private-networks": [
        {
          "id": "string",
          "mac-address": "string"
        }
      ],
      "public-ip": "string",
      "public-ip-assignment": "inet4",
      "secureboot-enabled": true,
      "security-groups": [
        {
          "description": "string",
          "external-sources": [
            null
          ],
          "id": "string",
          "name": "string",
          "rules": [
            null
          ]
        }
      ],
      "snapshots": [
        {
          "application-consistent": true,
          "created-at": "2024-01-01T12:00:00Z",
          "export": {
            "md5sum": null,
            "presigned-url": null
          },
          "id": "string",
          "instance": {
            "anti-affinity-groups": null,
            "application-consistent-snapshot-enabled": null,
            "created-at": null,
            "deploy-target": null,
            "disk-size": null,
            "elastic-ips": null,
            "id": null,
            "instance-type": null,
            "ipv6-address": null,
            "labels": null,
            "mac-address": null,
            "manager": null,
            "name": null,
            "private-networks": null,
            "public-ip": null,
            "public-ip-assignment": null,
            "secureboot-enabled": null,
            "security-groups": null,
            "snapshots": null,
            "ssh-key": null,
            "ssh-keys": null,
            "state": null,
            "template": null,
            "tpm-enabled": null,
            "user-data": null
          },
          "name": "string",
          "size": 0,
          "state": "snapshotting"
        }
      ],
      "ssh-key": {
        "fingerprint": "string",
        "name": "string"
      },
      "ssh-keys": [
        {
          "fingerprint": "string",
          "name": "string"
        }
      ],
      "state": "expunging",
      "template": {
        "application-consistent-snapshot-enabled": true,
        "boot-mode": "legacy",
        "build": "string",
        "checksum": "string",
        "created-at": "2024-01-01T12:00:00Z",
        "default-user": "string",
        "description": "string",
        "family": "string",
        "id": "string",
        "maintainer": "string",
        "name": "string",
        "password-enabled": true,
        "size": 0,
        "ssh-key-enabled": true,
        "url": "string",
        "version": "string",
        "visibility": "private",
        "zones": [
          "ch-dk-2"
        ]
      },
      "tpm-enabled": true,
      "user-data": "string"
    }
  ],
  "name": "string"
}

SDK reference for get-anti-affinity-group: golang | Python | Java

CLI: exo api get-anti-affinity-group

delete-anti-affinity-group

Delete an Anti-affinity Group

DELETE /anti-affinity-group/{id}

Path parameters

NameInDescription
idpath

Responses

Status: 200 - 200

Content-Type: application/json

PropertyTypeDescription
idstringOperation ID
messagestringOperation message
reasonstringOperation failure reason

Allowed values: incorrect, unknown, unavailable, forbidden, busy, fault, partial, not-found, interrupted, unsupported, conflict.
referenceobjectRelated resource reference schema details
statestringOperation status

Allowed values: failure, pending, success, timeout.
Example output
{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for delete-anti-affinity-group: golang | Python | Java

CLI: exo api delete-anti-affinity-group


Other Operations

list-anti-affinity-groups

List Anti-affinity Groups

GET /anti-affinity-group

Responses

Status: 200 - 200

Content-Type: application/json

PropertyTypeDescription
anti-affinity-groupsarray[object]schema details
Example output
{
  "anti-affinity-groups": [
    {
      "description": "string",
      "id": "string",
      "instances": [
        {
          "anti-affinity-groups": [
            null
          ],
          "application-consistent-snapshot-enabled": true,
          "created-at": "2024-01-01T12:00:00Z",
          "deploy-target": {
            "description": null,
            "id": null,
            "name": null,
            "type": null
          },
          "disk-size": 0,
          "elastic-ips": [
            null
          ],
          "id": "string",
          "instance-type": {
            "authorized": null,
            "cpus": null,
            "family": null,
            "gpus": null,
            "id": null,
            "memory": null,
            "size": null,
            "zones": null
          },
          "ipv6-address": "string",
          "labels": {},
          "mac-address": "string",
          "manager": {
            "id": null,
            "type": null
          },
          "name": "string",
          "private-networks": [
            null
          ],
          "public-ip": "string",
          "public-ip-assignment": "inet4",
          "secureboot-enabled": true,
          "security-groups": [
            null
          ],
          "snapshots": [
            null
          ],
          "ssh-key": {
            "fingerprint": null,
            "name": null
          },
          "ssh-keys": [
            null
          ],
          "state": "expunging",
          "template": {
            "application-consistent-snapshot-enabled": null,
            "boot-mode": null,
            "build": null,
            "checksum": null,
            "created-at": null,
            "default-user": null,
            "description": null,
            "family": null,
            "id": null,
            "maintainer": null,
            "name": null,
            "password-enabled": null,
            "size": null,
            "ssh-key-enabled": null,
            "url": null,
            "version": null,
            "visibility": null,
            "zones": null
          },
          "tpm-enabled": true,
          "user-data": "string"
        }
      ],
      "name": "string"
    }
  ]
}

SDK reference for list-anti-affinity-groups: golang | Python | Java

CLI: exo api list-anti-affinity-groups

Last updated on