NSX-T Data Center REST API

Get the status of the load balancer virtual server (Deprecated)

Returns the status of the virtual server by given load balancer serives id
and load balancer virtual server id.
Deprecated:
Use the following Policy API -
GET /policy/api/v1/infra/lb-services/<lb-service-id>/lb-virtual-servers/<lb-virtual-server-id>/detailed-status

Request:

Method:

GET

URI Path(s):

/api/v1/loadbalancer/services/{service-id}/virtual-servers/{virtual-server-id}/status

Request Headers:

n/a

Query Parameters:

DataSourceParameters+

DataSourceParameters (schema)

Name	Description	Type	Notes
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType

Request Body:

n/a

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

LbVirtualServerStatus+

LbVirtualServerStatus (schema)

Name	Description	Type	Notes
last_update_timestamp	Timestamp when the data was last updated.	EpochMsTimestamp
status	Virtual server status UP means that all primary members in default pool are in UP status. For L7 virtual server, if there is no default pool, the virtual server would be treated as UP. PARTIALLY_UP means that some(not all) primary members in default pool are in UP status. The size of these active primary members should be larger than or equal to the certain number(min_active_members) which is defined in LbPool. When there are no backup members which are in the UP status, the number(min_active_members) would be ignored. PRIMARY_DOWN means that less than certain(min_active_members) primary members in default pool are in UP status but backup members are in UP status, the connections would be dispatched to backup members. DOWN means that all primary and backup members are in DOWN status. DETACHED means that the virtual server is not bound to any service. DISABLED means that the admin state of the virtual server is disabled. UNKNOWN means that no status reported from transport-nodes. The associated load balancer service may be working(or not working).	string	Enum: UP, PARTIALLY_UP, PRIMARY_DOWN, DOWN, DETACHED, DISABLED, UNKNOWN
virtual_server_id	load balancer virtual server identifier	string	Required

Example Response:

{ "virtual_server_id" : "6be3337b-42c9-4ad6-8184-82ecb7a3234d", "status" : "UP" }

Required Permissions:

read

Feature:

lb_virtual_servers

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable