List All Bridge Clusters (Deprecated)

Returns information about all configured bridge clusters.
ESXI host bridge cluster is deprecated and only Edge Bridge cluster is supported.

Request:

Method:

GET

URI Path(s):

/api/v1/bridge-clusters

Request Headers:

n/a

Query Parameters:

ListRequestParameters+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/bridge-clusters

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

BridgeClusterListResult+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	BridgeCluster Results	array of BridgeCluster	Required Readonly Minimum items: 0
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "result_count" : 2, "results" : [ { "id" : "07419c2e-3d0e-48af-b1d1-380ffb6f5943", "display_name" : "bc1", "description" : "Bridge Cluster 1", "resource_type" : "BridgeCluster", "cluster_profile_bindings" : [ { "profile_id" : "fc77aa06-3d41-51e4-43f5-24ffc73d07953", "resource_type" : "BridgeHighAvailabilityClusterProfile" } ], "bridge_nodes" : [ { "ha_mac" : "02:50:56:00:00:00", "transport_node_id" : "49eab11e-84d2-4e86-a851-2d52750b813f" }, { "ha_mac" : "02:50:56:00:00:01", "transport_node_id" : "d64cf192-dbc1-49fa-91ef-e4049ec1f900" } ], "_last_modified_time" : 1442859342696, "_create_time" : 1442859342696, "_system_owned" : false, "_create_user" : "admin;default", "_last_modified_user" : "admin;default", "_revision" : 0 }, { "id" : "0f473f0f-b5a3-4a97-bf0f-d855163667e1", "display_name" : "bc2", "description" : "Bridge Cluster 2", "resource_type" : "BridgeCluster", "cluster_profile_bindings" : [ { "profile_id" : "fc77aa06-3d41-51e4-43f5-24ffc73d07953", "resource_type" : "BridgeHighAvailabilityClusterProfile" } ], "bridge_nodes" : [ { "ha_mac" : "02:50:56:00:00:02", "transport_node_id" : "49eab11e-84d2-4e86-a851-2d52750b813f" } ], "_last_modified_time" : 1442859441496, "_create_time" : 1442859441496, "_system_owned" : false, "_create_user" : "admin;default", "_last_modified_user" : "admin;default", "_revision" : 0 } ] }

List All Bridge Clusters (Deprecated)

Request:

ListRequestParameters (schema)

Example Request:

Successful Response:

BridgeClusterListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: