• Elastic Load Balancing

elb
  1. Help Center
  2. Elastic Load Balancing
  3. API Reference
  4. Enhanced Load Balancer APIs
  5. Load Balancer
  6. Querying the Status Tree of a Load Balancer

Querying the Status Tree of a Load Balancer

Function

This API is used to query the status tree of a load balancer. You can use this API to query information about the associated listeners, backend server groups, backend servers, health checks, forwarding policies, and forwarding rules and understand the topology of resources associated with the load balancer.

URI

GET /v2.0/lbaas/loadbalancers/{loadbalancer_id}/statuses

Table 1 Parameter description

Parameter

Type

Mandatory

Description

loadbalancer_id

Uuid

Yes

Specifies the load balancer ID.

Request

None

Response

Table 2 Parameter description

Parameter

Type

Description

statuses

Dict

Specifies the status tree of a load balancer.

Table 3 statuses field description

Parameter

Type

Description

loadbalancer

Dict

Specifies the load balancer.

Table 4 loadbalancer field description

Parameter

Type

Description

id

Uuid

Specifies the load balancer ID.

name

String (255)

Specifies the load balancer name.

listeners

List

Lists the listeners added to the load balancer. For details about this parameter, see Table 5.

pools

List

Lists the backend server groups associated with the load balancer. For details about this parameter, see Table 6.

operating_status

String (16)

  • Specifies the operating status of the load balancer.
  • The value can be ONLINE, OFFLINE, DEGRADED, DISABLED, or NO_MONITOR.
  • This parameter is reserved and has been not used. The default value is ONLINE.

provisioning_status

String (16)

  • Specifies the provisioning status of the load balancer.
  • The value can be ACTIVE, PENDING_CREATE, or ERROR.
  • This parameter is reserved and has been not used. The default value is ACTIVE.
Table 5 listeners field description

Parameter

Type

Description

id

Uuid

Specifies the listener ID.

name

String (255)

Specifies the listener name.

l7policies

List

Lists associated forwarding policies. For details about this parameter, see Table 9.

pools

List

Lists the backend server groups associated with the listener. For details about this parameter, see Table 6.

operating_status

String (16)

  • Specifies the operating status of the listener.
  • The value can be ONLINE, OFFLINE, DEGRADED, DISABLED, or NO_MONITOR.
  • This parameter is reserved and has been not used. The default value is ONLINE.

provisioning_status

String (16)

  • Specifies the provisioning status of the listener.
  • The value can be ACTIVE, PENDING_CREATE, or ERROR.
  • This parameter is reserved and has been not used. The default value is ACTIVE.
Table 6 pools field description

Parameter

Type

Description

id

Uuid

Specifies the backend server group ID.

name

String (255)

Specifies the backend server group name.

healthmonitor

Dict

Provides health check details of the backend server group. For details about this parameter, see Table 7.

members

List

Lists the members contained in the backend server group. For details about this parameter, see Table 8.

operating_status

String (16)

  • Specifies the operating status of the backend server group.
  • The value can be ONLINE, OFFLINE, DEGRADED, DISABLED, or NO_MONITOR.
  • This parameter is reserved and has been not used. The default value is ONLINE.

provisioning_status

String (16)

  • Specifies the provisioning status of the backend server group.
  • The value can be ACTIVE, PENDING_CREATE, or ERROR.
  • This parameter is reserved and has been not used. The default value is ACTIVE.
Table 7 healthmonitor field description

Parameter

Type

Description

id

Uuid

Specifies the health check ID.

name

String (255)

Specifies the health check name.

type

String

  • Specifies the health check protocol.
  • The value can be UDP_CONNECT, TCP, or HTTP.

provisioning_status

String (16)

  • Indicates the provisioning status of the health check.
  • The value can be ACTIVE, PENDING_CREATE, or ERROR.
  • This parameter is reserved and has been not used. The default value is ACTIVE.
Table 8 members field description

Parameter

Type

Description

id

Uuid

Specifies the backend server ID.

address

String (64)

Specifies the private IP address of the backend server.

for example, 192.168.3.11.

protocol_port

Int

  • Specifies the backend port.
  • The port number ranges from 0 to 65535.

operating_status

String (16)

  • Specifies the health check result of the backend server.
  • The value can be ONLINE, OFFLINE, DEGRADED, DISABLED, or NO_MONITOR. ONLINE: The backend server is healthy. OFFLINE: The backend server is unhealthy. DISABLED: The backend server does not exist. NO_MONITOR: The health check is disabled.

provisioning_status

String (16)

  • Specifies the provisioning status of the backend server.
  • The value can be ACTIVE, PENDING_CREATE, or ERROR.
  • This parameter is reserved and has been not used. The default value is ACTIVE.
Table 9 l7policies field description

Parameter

Type

Description

id

Uuid

Specifies the forwarding policy ID.

name

String (255)

Specifies the forwarding policy name.

rules

List

Lists forwarding rules of the forwarding policy. For details about this parameter, see Table 10.

action

String

  • Specifies the matching action of the forwarding policy.
  • The value can be REDIRECT_TO_POOL or REDIRECT_TO_LISTENER.
    • REDIRECT_TO_POOL: forwards the requests matching this policy to the backend server group.
    • REDIRECT_TO_LISTENER: redirects requests matching this policy to the associated listener.

provisioning_status

String (16)

  • Specifies the provisioning status of the forwarding policy.
  • The value can be ACTIVE, PENDING_CREATE, or ERROR.
  • This parameter is reserved and has been not used. The default value is ACTIVE.
Table 10 rules field description

Parameter

Type

Description

id

Uuid

Specifies the forwarding rule ID.

type

String

  • Specifies the match content of a forwarding rule.
  • The value can be PATH or HOST_NAME.
    • PATH: matches the path in the request.
    • HOST_NAME: matches the domain name in the request.

provisioning_status

String (16)

  • Specifies the provisioning status of the forwarding rule.
  • The value can be ACTIVE, PENDING_CREATE, or ERROR.
  • This parameter is reserved and has been not used. The default value is ACTIVE.

Example

  • Example request
    GET https://{Endpoint}/v2.0/lbaas/loadbalancers/38278031-cfca-44be-81be-a412f618773b/statuses
  • Example response
    {
        "statuses": {
            "loadbalancer": {
                "name": "lb-jy",
                "provisioning_status": "ACTIVE",
                "listeners": [
                    {
                        "name": "listener-jy-1",
                        "provisioning_status": "ACTIVE",
                        "pools": [
                            {
                                "name": "pool-jy-1",
                                "provisioning_status": "ACTIVE",
                                "healthmonitor": {
                                    "type": "TCP",
                                    "id": "7422b51a-0ed2-4702-9429-4f88349276c6",
                                    "name": "",
                                    "provisioning_status": "ACTIVE"
                                },
                                "members": [
                                    {
                                        "protocol_port": 80,
                                        "address": "192.168.44.11",
                                        "id": "7bbf7151-0dce-4087-b316-06c7fa17b894",
                                        "operating_status": "ONLINE",
                                        "provisioning_status": "ACTIVE"
                                    }
                                ],
                                "id": "c54b3286-2349-4c5c-ade1-e6bb0b26ad18",
                                "operating_status": "ONLINE"
                            }
                        ],
                        "l7policies": [],
                        "id": "eb84c5b4-9bc5-4bee-939d-3900fb05dc7b",
                        "operating_status": "ONLINE"
                    }
                ],
                "pools": [
                    {
                        "name": "pool-jy-1",
                        "provisioning_status": "ACTIVE",
                        "healthmonitor": {
                            "type": "TCP",
                            "id": "7422b51a-0ed2-4702-9429-4f88349276c6",
                            "name": "",
                            "provisioning_status": "ACTIVE"
                        },
                        "members": [
                            {
                                "protocol_port": 80,
                                "address": "192.168.44.11",
                                "id": "7bbf7151-0dce-4087-b316-06c7fa17b894",
                                "operating_status": "ONLINE",
                                "provisioning_status": "ACTIVE"
                            }
                        ],
                        "id": "c54b3286-2349-4c5c-ade1-e6bb0b26ad18",
                        "operating_status": "ONLINE"
                    }
                ],
                "id": "38278031-cfca-44be-81be-a412f618773b",
                "operating_status": "ONLINE"
            }
        }
    }

Response Codes

For details, see HTTP Status Codes for Enhanced Load Balancers.