Get the status of the given load balancer service

Returns the status of the given load balancer service.

Request:

Method:

GET

URI Path(s):

/api/v1/loadbalancer/services/<service-id>/status

Request Headers:

n/a

Query Parameters:

LbServiceStatusQueryParameters+

Name	Description	Type	Notes
include_instance_details	Flag to indicate whether include detail information The flag to indicate whether include detail information. Load balancer instance detail information will be returned if this field is set to true. It's only valid in realtime status query.	boolean	Default: "False"
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType
transport_node_ids	The UUIDs of transport nodes The UUIDs of transport nodes. Multiple UUIDs should be separated by commas. If this field is specified, only the status from the given transport nodes will be returned. It's only valid in realtime status query.	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/loadbalancer/services/a0de28f3-c0f7-445c-a624-265175da795d/status

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

LbServiceStatus+

LbServiceStatus (schema)

Name	Description	Type	Notes
active_transport_nodes	Ids of load balancer service related active transport nodes	array of string
cpu_usage	Cpu usage in percentage	integer
error_message	Error message, if available	string
instance_detail_per_tn	Details of load balancer service instance per transport node Details of load balancer service instance per transport node.	array of LbServiceInstanceDetailPerTransportNode
last_update_timestamp	Timestamp when the data was last updated	EpochMsTimestamp
memory_usage	Memory usage in percentage	integer
pools	status of load balancer pools	array of LbPoolStatus
service_id	Load balancer service identifier	string	Required
service_status	Status of load balancer service UP means the load balancer service is working fine on both transport-nodes(if have); PARTIALLY_UP means that some DLB instances on transport node are working successfully and some instances are not working successfully; 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).	string	Enum: UP, PARTIALLY_UP, DOWN, ERROR, NO_STANDBY, DETACHED, DISABLED, UNKNOWN
standby_transport_nodes	Ids of load balancer service related standby transport nodes	array of string
virtual_servers	status of load balancer virtual servers	array of LbVirtualServerStatus

Example Response:

{ "virtual_servers" : [ { "virtual_server_id" : "6be3337b-42c9-4ad6-8184-82ecb7a3234d", "status" : "UP" }, { "virtual_server_id" : "19ba1f6b-09d7-43df-ae1e-4d491d766d20", "status" : "UP" } ], "standby_transport_nodes" : [ "c2d821c4-f9b4-11e7-84be-000c29641b42" ], "last_update_timestamp" : 1516001961249, "service_id" : "a0de28f3-c0f7-445c-a624-265175da795d", "service_status" : "UP", "pools" : [ { "members" : [ { "port" : "80", "ip_address" : "192.168.1.10", "status" : "UP" }, { "port" : "80", "ip_address" : "192.168.2.10", "status" : "UP" } ], "pool_id" : "029a843e-ae42-4bdf-9f84-8b1f94cb380d", "status" : "UP" }, { "members" : [ { "port" : "9090", "ip_address" : "192.168.1.10", "status" : "UP" }, { "port" : "9090", "ip_address" : "192.168.2.10", "status" : "UP" } ], "pool_id" : "4818b7d5-2bc7-4135-bb25-ae6a4c42a125", "status" : "UP" } ], "memory_usage" : 1, "active_transport_nodes" : [ "b665f79a-f9b4-11e7-a7f1-000c29b74dbd" ], "cpu_usage" : 0 }

Get the status of the given load balancer service

Request:

LbServiceStatusQueryParameters (schema)

Example Request:

Successful Response:

LbServiceStatus (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: