Get LBService status information

Get LBService detailed status information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.
This API is available when using VMware Cloud (AWS, Dell-EMC, Outpost, Hyperscalers) or VMware NSX-T.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/lb-services/<lb-service-id>/detailed-status

Request Headers:

n/a

Query Parameters:

LBServiceStatusQueryParameters+

Name	Description	Type	Notes
enforcement_point_path	String Path of the enforcement point enforcement point path, forward slashes must be escaped using %2F.	string
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

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

AggregateLBServiceStatus+

Name	Description	Type	Notes
intent_path	String Path of the intent object Intent path of object, forward slashes must be escaped using %2F.	string	Required Readonly
results	LBServiceStatusPerEP list results LBServiceStatusPerEP list results.	array of LBServiceStatusPerEP (Abstract type: pass one of the following concrete types) LBServiceStatus	Readonly

Required Permissions:

read

Feature:

policy_statistics

Additional Errors:

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