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, DISABLED is returned for operating_status of the backend server in the response of this API.
URI¶
GET /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}/statuses
Parameter | Mandatory | Type | Description |
|---|---|---|---|
project_id | Yes | String | Specifies the project ID. |
loadbalancer_id | Yes | String | Specifies the load balancer ID. |
Request Parameters¶
Parameter | Mandatory | Type | Description |
|---|---|---|---|
X-Auth-Token | Yes | String | Specifies the token used for IAM authentication. |
Response Parameters¶
Status code: 200
Parameter | Type | Description |
|---|---|---|
statuses | LoadBalancerStatusResult object | Provides information about the load balancer status tree. |
request_id | String | Specifies the request ID. The value is automatically generated. |
Parameter | Type | Description |
|---|---|---|
loadbalancer | LoadBalancerStatus object | Specifies the statuses of the load balancer and its associated resources. |
Parameter | Type | Description |
|---|---|---|
name | String | Specifies the load balancer name. Minimum: 1 Maximum: 255 |
provisioning_status | String | Specifies the provisioning status of the load balancer. The value can be ACTIVE or PENDING_DELETE.
|
listeners | Array of LoadBalancerStatusListener objects | Lists the listeners added to the load balancer. |
pools | Array of LoadBalancerStatusPool objects | Lists the backend server groups associated with the load balancer. |
id | String | Specifies the load balancer ID. |
operating_status | String | Specifies the operating status of the load balancer. The value can only be one of the following:
DEGRADED and DISABLED are returned only when the API for querying the load balancer status tree is called. |
Parameter | Type | Description |
|---|---|---|
name | String | Specifies the name of the listener added to the load balancer. Minimum: 1 Maximum: 255 |
provisioning_status | String | Specifies the provisioning status of the listener. The value can only be ACTIVE, indicating that the listener is successfully provisioned. |
pools | Array of LoadBalancerStatusPool objects | Specifies the operating status of the backend server group associated with the listener. |
l7policies | Array of LoadBalancerStatusPolicy objects | Specifies the operating status of the forwarding policy added to the listener. |
id | String | Specifies the listener ID. |
operating_status | String | Specifies the operating status of the listener. The value can only be one of the following:
|
Parameter | Type | Description |
|---|---|---|
action | String | Specifies whether requests are forwarded to another backend server group or redirected to an HTTPS listener. The value can be one of the following:
|
id | String | Specifies the forwarding policy ID. |
provisioning_status | String | Specifies the provisioning status of the forwarding policy.
|
name | String | Specifies the policy name. Minimum: 1 Maximum: 255 |
rules | Array of LoadBalancerStatusL7Rule objects | Specifies the forwarding rule. |
Parameter | Type | Description |
|---|---|---|
id | String | Specifies the ID of the forwarding rule. |
type | String | Specifies the type of the match content. The value can be HOST_NAME or PATH.
The value must be unique for each forwarding rule in a forwarding policy. |
provisioning_status | String | Specifies the provisioning status of the forwarding rule.
|
Parameter | Type | Description |
|---|---|---|
provisioning_status | String | Specifies the provisioning status of the backend server group. The value can only be ACTIVE, indicating that the backend server group is successfully provisioned. |
name | String | Specifies the name of the backend server group. Minimum: 1 Maximum: 255 |
healthmonitor | Specifies the health check results of backend servers in the load balancer status tree. | |
members | Array of LoadBalancerStatusMember objects | Specifies the backend server. |
id | String | Specifies the ID of the backend server group. |
operating_status | String | Specifies the operating status of the backend server group. The value can be one of the following:
Note: DEGRADED and DISABLED are returned only when the API for querying the load balancer status tree is called. |
Parameter | Type | Description |
|---|---|---|
type | String | Specifies the health check protocol. The value can be TCP, UDP_CONNECT, or HTTP. |
id | String | Specifies the health check ID. |
name | String | Specifies the health check name. Minimum: 1 Maximum: 255 |
provisioning_status | String | Specifies the provisioning status of the health check. The value can only be ACTIVE, indicating that the health check is successfully provisioned. |
Parameter | Type | Description |
|---|---|---|
provisioning_status | String | Specifies the provisioning status of the backend server. The value can only be ACTIVE, indicating that the backend server is successfully provisioned. |
address | String | Specifies the private IP address bound to the backend server. |
protocol_port | Integer | Specifies the port used by the backend server to receive requests. The port number ranges from 1 to 65535. |
id | String | Specifies the backend server ID. |
operating_status | String | Specifies the operating status of the backend server. The value can be one of the following:
|
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.