Abiquo Documentation Cookies Policy

Our Documentation website uses cookies to improve your experience. Please visit our Cookie Policy page for more information about cookies and how we use them.

Skip to end of metadata
Go to start of metadata

Health Check Resource

Main URI of the Resource

This class operates mainly over the Resource URI: /cloud/locations/{location}/loadbalancers/{loadbalancer}/healthchecks

Exposed Methods

List all the Health Checks in the LoadBalancer

Synopsis: GET /cloud/locations/{location}/loadbalancers/{loadbalancer}/healthchecks
Roles required: ROLE_MANAGE_LOADBALANCERS
Request headers: Accept: application/vnd.abiquo.healthchecks+json; version=3.1; application/vnd.abiquo.healthchecks+xml; version=3.1;
Request parameters:

curl --verbose -XGET http://admin:xabiquo@10.60.1.223:80/api/cloud/locations/1/loadbalancers/1/healthchecks

Response

 Click here to show/hide example
{
  "collection": [
    {
      "attempts": 2,
      "timeoutInMs": 5000,
      "intervalInMs": 30000,
      "providerId": "Z3NF1Z3NOM5OY2TCP:443",
      "port": 443,
      "protocol": "TCP",
      "name": "TCP:443",
      "links": [
        {
          "href": "http://10.60.1.223:80/api/cloud/locations/1/loadbalancers/1/healthchecks/1",
          "type": "application/vnd.abiquo.healthcheck+json",
          "rel": "edit",
          "title": "TCP:443[protocol:TCP,path:null]"
        },
        {
          "href": "http://10.60.1.223:80/api/cloud/locations/1/loadbalancers/1",
          "type": "application/vnd.abiquo.loadbalancer+json",
          "rel": "loadbalancer",
          "title": "a"
        }
      ]
    }
  ],
  "links": []
}

Get a Health Check in the LoadBalancer

Synopsis: GET /cloud/locations/{location}/loadbalancers/{loadbalancer}/healthchecks/{healthcheck}
Roles required: ROLE_MANAGE_LOADBALANCERS
Request headers: Accept: application/vnd.abiquo.healthcheck+json; version=3.1; application/vnd.abiquo.healthcheck+xml; version=3.1;
Request parameters:

curl --verbose -XGET http://admin:xabiquo@10.60.1.223:80/api/cloud/locations/1/loadbalancers/1/healthchecks/1

Response

 Click here to show/hide example
{
  "attempts": 2,
  "timeoutInMs": 5000,
  "intervalInMs": 30000,
  "providerId": "Z3NF1Z3NOM5OY2TCP:443",
  "port": 443,
  "protocol": "TCP",
  "name": "TCP:443",
  "links": [
    {
      "href": "http://10.60.1.223:80/api/cloud/locations/1/loadbalancers/1/healthchecks/1",
      "type": "application/vnd.abiquo.healthcheck+json",
      "rel": "edit",
      "title": "TCP:443[protocol:TCP,path:null]"
    },
    {
      "href": "http://10.60.1.223:80/api/cloud/locations/1/loadbalancers/1",
      "type": "application/vnd.abiquo.loadbalancer+json",
      "rel": "loadbalancer",
      "title": "a"
    }
  ]
}

Create a new Health Check in the Load Balancer

Some providers only allow a single Health Check for each Load Balancer. AWS creates a default health check and allows multiple health checks.
Synopsis: POST /cloud/locations/{location}/loadbalancers/{loadbalancer}/healthchecks
Roles required: ROLE_MANAGE_LOADBALANCERS
Request headers: Accept: application/vnd.abiquo.healthcheck+json; version=3.1; application/vnd.abiquo.healthcheck+xml; version=3.1; Content-Type: application/vnd.abiquo.healthcheck+json; version=3.1; application/vnd.abiquo.healthcheck+xml; version=3.1;
Request parameters:
 

 Click here to show/hide example
curl --verbose -XPOST http://admin:xabiquo@10.60.1.223:80/api/cloud/locations/1/loadbalancers/1/healthchecks -H "Content-Type: application/vnd.abiquo.healthcheck+json" -d '{
  "attempts": 2,
  "timeoutInMs": 5000,
  "intervalInMs": 30000,
  "port": 1025,
  "protocol": "HTTP",
  "path": "index.html",
  "name": "otherHC"
}'

Response
 

 Click here to show/hide example
{
  "attempts": 2,
  "timeoutInMs": 5000,
  "intervalInMs": 30000,
  "providerId": "Z3NF1Z3NOM5OY2TCP:443",
  "port": 443,
  "protocol": "HTTP",
  "path": "index.html",
  "name": "otherHC",
  "links": [
    {
      "href": "http://10.60.1.223:80/api/cloud/locations/1/loadbalancers/1/healthchecks/2",
      "type": "application/vnd.abiquo.healthcheck+json",
      "rel": "edit",
      "title": "otherHC"
    },
    {
      "href": "http://10.60.1.223:80/api/cloud/locations/1/loadbalancers/1",
      "type": "application/vnd.abiquo.loadbalancer+json",
      "rel": "loadbalancer",
      "title": "a"
    }
  ]
}

Modify an existing Health Check in the LoadBalancer

Synopsis: PUT /cloud/locations/{location}/loadbalancers/{loadbalancer}/healthchecks/{healthcheck}
Roles required: ROLE_MANAGE_LOADBALANCERS
Request headers: Accept: application/vnd.abiquo.healthcheck+json; version=3.1; application/vnd.abiquo.healthcheck+xml; version=3.1; Content-Type: application/vnd.abiquo.healthcheck+json; version=3.1; application/vnd.abiquo.healthcheck+xml; version=3.1;
Request parameters:
 

 Click here to show/hide example
curl --verbose -XPUT http://admin:xabiquo@10.60.1.223:80/api/cloud/locations/1/loadbalancers/1/healthchecks/1 -H "Content-Type: application/vnd.abiquo.healthcheck+json" -d '{
  "attempts": 3,
  "timeoutInMs": 5000,
  "intervalInMs": 30000,
  "port": 443,
  "protocol": "TCP",
  "name": "newname"
}'

Response

 Click here to show/hide example
{
    "attempts": 3,
    "intervalInMs": 30000,    
    "name": "newname",
    "port": 443,
    "protocol": "TCP",
    "providerId": "aTCP:443",
    "timeoutInMs": 5000,
    "links": [
        {
            "href": "http://10.60.1.223:80/api/cloud/locations/1/loadbalancers/1/healthchecks/1",
            "rel": "edit",
            "title": "newname[protocol:TCP,path:null]",
            "type": "application/vnd.abiquo.healthcheck+json"
        },
        {
            "href": "http://10.60.1.223:80/api/cloud/locations/1/loadbalancers/1",
            "rel": "loadbalancer",
            "title": "a",
            "type": "application/vnd.abiquo.loadbalancer+json"
        }
    ]
}

Delete a Health Check in the LoadBalancer

Some providers do not allow you to remove Health Checks
Synopsis: DELETE /cloud/locations/{location}/loadbalancers/{loadbalancer}/healthchecks/{healthcheck}
Roles required: ROLE_MANAGE_LOADBALANCERS
Request headers: Accept: application/vnd.abiquo.healthcheck+json; version=3.1; application/vnd.abiquo.healthcheck+xml; version=3.1; Content-Type: application/vnd.abiquo.healthcheck+json; version=3.1; application/vnd.abiquo.healthcheck+xml; version=3.1;
Request parameters:

curl --verbose -XDELETE http://admin:xabiquo@10.60.1.223:80/api/cloud/locations/1/loadbalancers/1/healthchecks/1

Response

204 No Content
  • No labels