Help Center/ Elastic Load Balance/ API Reference/ APIs (V3)/ Load Balancer/ Querying the Status Tree of a Load Balancer
Updated on 2025-08-29 GMT+08:00

Querying the Status Tree of a Load Balancer

Function

This API is used to query the status tree of a load balancer and to show information about all resources associated with the load balancer.

When admin_state_up is set to false and operating_status to OFFLINE for a backend server, DISABLE is returned for operating_status of the backend server in the response of this API.

Calling Method

For details, see Calling APIs.

URI

GET /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}/statuses

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition: Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID.

Constraints: N/A

Range: The value can contain a maximum of 32 characters, including digits and lowercase letters.

Default value: N/A

loadbalancer_id

Yes

String

Definition: Specifies the load balancer ID.

Constraints: N/A

Range: N/A

Default value: N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition: Specifies the token used for IAM authentication.

Constraints: N/A

Range: N/A

Default value: N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

statuses

LoadBalancerStatusResult object

Definition: Provides supplementary information about the load balancer status tree.

Default value: N/A

request_id

String

Definition: Specifies the request ID.

Range: The value is automatically generated, and can contain characters including digits, lowercase letters, and hyphens (-).

Table 4 LoadBalancerStatusResult

Parameter

Type

Description

loadbalancer

LoadBalancerStatus object

Definition: Specifies the status of the load balancer and its associated resources.

Default value: N/A

Table 5 LoadBalancerStatus

Parameter

Type

Description

name

String

Definition: Specifies the load balancer name.

Range: N/A

provisioning_status

String

Definition: Specifies the provisioning status of the load balancer.

Range:

  • ACTIVE: in use

  • PENDING_DELETE: deleting

listeners

Array of LoadBalancerStatusListener objects

Definition: Lists the listeners added to the load balancer.

Range: N/A

pools

Array of LoadBalancerStatusPool objects

Definition: Lists the backend server groups associated with the load balancer.

Range: N/A

id

String

Definition: Specifies the load balancer ID.

Range: N/A

operating_status

String

Definition: Specifies the operating status of the load balancer.

Range:

  • ONLINE: The load balancer is running normally.

  • FROZEN: The load balancer is frozen.

  • DEGRADED: This status is displayed only when operating_status is set to OFFLINE for a backend server associated with the load balancer.

  • DISABLED: This status is displayed only when admin_state_up of the load balancer is set to false.

NOTE:
DEGRADED and DISABLED are returned only when the API for querying the load balancer status tree is called.
Table 6 LoadBalancerStatusListener

Parameter

Type

Description

name

String

Definition: Specifies the name of the listener.

Range: N/A

provisioning_status

String

Definition: Specifies the provisioning status of the listener.

Range:

  • ACTIVE: in use

pools

Array of LoadBalancerStatusPool objects

Definition: Specifies the operating status of the backend server groups associated with the listener.

Range: N/A

l7policies

Array of LoadBalancerStatusPolicy objects

Definition: Specifies the statuses of forwarding policies in the load balancer status tree.

Default value: N/A

id

String

Definition: Specifies the listener ID.

Range: N/A

operating_status

String

Definition: Specifies the operating status of the listener.

Range:

  • ONLINE (default): The listener is running normally.

  • DEGRADED: This status is displayed only when provisioning_status of a forwarding policy or a forwarding rule added to the listener is set to ERROR or operating_status is set to OFFLINE for a backend server associated with the listener.

  • DISABLED: This status is displayed only when admin_state_up of the load balancer or of the listener is set to false.

NOTE:
DEGRADED and DISABLED are returned only when the API for querying the load balancer status tree is called.
Table 7 LoadBalancerStatusPolicy

Parameter

Type

Description

action

String

Definition: Specifies whether requests are forwarded to another backend server group or redirected to an HTTPS listener.

Range:

  • REDIRECT_TO_POOL: Requests are forwarded to another backend server group.

  • REDIRECT_TO_LISTENER: Requests are redirected to an HTTPS listener.

id

String

Definition: Specifies the forwarding policy ID.

Range: N/A

provisioning_status

String

Definition: Specifies the provisioning status of the forwarding policy.

Range:

  • ACTIVE (default): The forwarding policy is provisioned successfully.

name

String

Definition: Specifies the forwarding policy name.

Range: N/A

rules

Array of LoadBalancerStatusL7Rule objects

Definition: Specifies the status of all forwarding rules in the forwarding policy.

Range: N/A

Table 8 LoadBalancerStatusL7Rule

Parameter

Type

Description

id

String

Definition: Specifies the ID of the forwarding rule.

Range: N/A

type

String

Definition: Specifies the type of the match content.

Range:

  • HOST_NAME: A domain name will be used for matching.

  • PATH: A URL will be used for matching.

provisioning_status

String

Definition: Specifies the provisioning status of the forwarding rule.

Range:

  • ACTIVE (default): The forwarding rule is in use.

  • ERROR: The forwarding policy has the same rule as another forwarding policy added to the same listener.

Table 9 LoadBalancerStatusPool

Parameter

Type

Description

provisioning_status

String

Definition: Specifies the provisioning status of the backend server group.

Range:

  • ACTIVE: in use

name

String

Definition: Specifies the backend server group name.

Range: N/A

healthmonitor

LoadBalancerStatusHealthMonitor object

Definition: Specifies the health check results of backend servers in the load balancer status tree.

Default value: N/A

members

Array of LoadBalancerStatusMember objects

Definition: Specifies the statuses of all backend servers in the backend server group.

Range: N/A

id

String

Definition: Specifies the backend server group ID.

Range: N/A

operating_status

String

Definition: Specifies the operating status of the backend server group.

Range:

  • ONLINE: The backend server group is running normally.

  • DEGRADED: This status is displayed only when operating_status of a backend server in the backend server group is set to OFFLINE.

  • DISABLED: This status is displayed only when admin_state_up of the backend server group or of the associated load balancer is set to false.

NOTE:
DEGRADED and DISABLED are returned only when the API for querying the load balancer status tree is called.
Table 10 LoadBalancerStatusHealthMonitor

Parameter

Type

Description

type

String

Definition: Specifies the health check protocol.

Range: TCP, UDP_CONNECT, or HTTP.

id

String

Definition: Specifies the health check ID.

Range: N/A

name

String

Definition: Specifies the health check name.

Range: N/A

provisioning_status

String

Definition: Specifies the provisioning status of the health check.

Range: The value can only be ACTIVE, indicating that the health check is in use.

Table 11 LoadBalancerStatusMember

Parameter

Type

Description

provisioning_status

String

Definition: Specifies the provisioning status of the backend server.

Range: The value can only be ACTIVE, indicating that the backend server is in use.

address

String

Definition: Specifies the IP address of the backend server.

Range: N/A

protocol_port

Integer

Definition: Specifies the port used by the backend server to receive requests.

Range: 1 to 65535

id

String

Definition: Specifies the backend server ID.

Range: N/A

operating_status

String

Definition: Specifies the operating status of the backend server.

Range:

  • ONLINE: The backend server is running normally.

  • NO_MONITOR: No health check is configured for the backend server group to which the backend server belongs.

  • DISABLED: The backend server is not available. This status is displayed only when admin_state_up of the backend server, or the backend server group to which it belongs, or the associated load balancer is set to false and the API for querying the load balancer status tree is called.

  • OFFLINE: The cloud server used as the backend server is stopped or does not exist.

Example Requests

Querying the status tree of a load balancer

GET https://{ELB_Endpoint}/v3/{project_id}/elb/loadbalancers/38278031-cfca-44be-81be-a412f618773b/statuses

Example Responses

Status code: 200

Successful request.

{
  "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"
    }
  }
}

Status Codes

Status Code

Description

200

Successful request.

Error Codes

See Error Codes.