Get Load Balancer Service Status

Returns the status of the given load balancer service.

Request

URI

GET

https://nsxmanager.your.domain/api/v1/loadbalancer/services/{service-id}/status

COPY

Path Parameters

string

service-id

Required

service-id

Query Parameters

string

source

Optional

Data source type.

Possible values are : realtime, cached,

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns LbServiceStatus of type(s) application/json

{
    "pools": [
        {
            "status": "string",
            "last_update_timestamp": 0,
            "pool_id": "string",
            "members": [
                {
                    "status": "string",
                    "failure_cause": "string",
                    "last_check_time": 0,
                    "ip_address": "string",
                    "last_state_change_time": 0,
                    "port": "string"
                }
            ]
        }
    ],
    "cpu_usage": 0,
    "active_transport_nodes": [
        "string"
    ],
    "memory_usage": 0,
    "service_id": "string",
    "last_update_timestamp": 0,
    "standby_transport_nodes": [
        "string"
    ],
    "error_message": "string",
    "virtual_servers": [
        {
            "status": "string",
            "last_update_timestamp": 0,
            "virtual_server_id": "string"
        }
    ],
    "service_status": "string"
}

array of LbPoolStatus

pools

Optional

status of load balancer pools

integer As int64 As int64

cpu_usage

Optional

Cpu usage in percentage

array of string

active_transport_nodes

Optional

Ids of load balancer service related active transport nodes

integer As int64 As int64

memory_usage

Optional

Memory usage in percentage

string

service_id

Required

Load balancer service identifier

integer As int64 As int64

last_update_timestamp

Optional

Timestamp when the data was last updated

array of string

standby_transport_nodes

Optional

Ids of load balancer service related standby transport nodes

string

error_message

Optional

Error message, if available

array of LbVirtualServerStatus

virtual_servers

Optional

status of load balancer virtual servers

string

service_status

Optional

UP means the load balancer service is working fine on both transport-nodes(if have); DOWN means the load balancer service is down on both transport-nodes (if have), hence the load balancer will not respond to any requests; ERROR means error happens on transport-node(s) or no status is reported from transport-node(s). The load balancer service may be working (or not working); NO_STANDBY means load balancer service is working in one of the transport node while not in the other transport-node (if have). Hence if the load balancer service in the working transport-node goes down, the load balancer service will go down; DETACHED means that the load balancer service has no attachment setting and is not instantiated in any transport nodes; DISABLED means that admin state of load balancer service is DISABLED; UNKNOWN means that no status reported from transport-nodes.The load balancer service may be working(or not working).