/mgmt/status/default/LoadBalancerStatus2 GET

Use the HTTP GET method with the /mgmt/status/default/LoadBalancerStatus2 resource to request status for any configured load balancer groups that the appliance is a member of.

Resource URL

https://host:port/mgmt/status/default/LoadBalancerStatus2
Where port is 5554 by default.

Request headers

The following header must be sent with the request:
Authorization
This header must be sent to perform authentication.

Request body format

None.

Security requirements

The caller must be authenticated as an appliance user with sufficient authority. For more information about security, see Types of user and how they are authenticated and User authorization, credential mapping, and access profiles.

Response status codes

200
Status information retrieved successfully.
400
Invalid data provided.
401
Not authenticated.
The caller must be authenticated as an appliance user. See Types of user and how they are authenticated for more information.
403
Not authorized.
The caller is authenticated but does not the authority to perform this action. See User authorization, credential mapping, and access profiles for more information.

Response headers

Content-Type
This header is returned with a value of application/json.

Response body format

The response is in JSON format. The response includes information about load balancer groups on the appliance. Each object contains the following fields:
Group
String.
The name of the load balancer group.
Server
String.
The IP address or host name of the load balancer member.
Port
Integer.
The member-specific target port or 0 if using the service-defined port.
Health
String.
The health status of a given load balancer member. Possible values are: up, softdown, or down.
Weight
Integer.
The weight given to this server. Weights are used in weighted load balancing decisions for algorithms such as Weighted Round Robin or Weighted Least Outstanding Connections.
AdminState
String.
The administrative state overrides the health of the server.
  • Enabled This load balancer member is administratively enabled. The server participates in load balancing and health check decisions.
  • Disabled This load balancer member is administratively disabled. The server is not included in any load balancing decisions.

Examples

The following example requests information about load balancer groups that the appliance belongs to.

The following URL is used with the HTTP GET method:
https://localhost:5554/mgmt/status/default/LoadBalancerStatus2
The following listing shows an example received response:
{
  "_links": {
    "self": {
      "href": "/mgmt/status/default/LoadBalancerStatus2"
    },
    "doc": {
      "href": "/mgmt/docs/status/LoadBalancerStatus2"
    }
  },
  "LoadBalancerStatus2": [
    {
      "Group": {
        "value": "pre_tend2",
        "href": "/mgmt/config/default/LoadBalancerGroup/pre_tend2"
      },
      "Server": "roundpen.com",
      "Port": 0,
      "Health": "up",
      "Weight": 1,
      "AdminState": "enabled"
    },
    {
      "Group": {
        "value": "pre_tend",
        "href": "/mgmt/config/default/LoadBalancerGroup/pretend"
      },
      "Server": "manege.com",
      "Port": 0,
      "Health": "up",
      "Weight": 1,
      "AdminState": "enabled"
    },
    {
      "Group": {
        "value": "pre_tend",
        "href": "/mgmt/config/default/LoadBalancerGroup/pre_tend"
      },
      "Server": "paddock.com",
      "Port": 0,
      "Health": "up",
      "Weight": 1,
      "AdminState": "enabled"
    }
  ]
}