Get Information about a bridge cluster (Deprecated)

Returns information about a specified bridge cluster. ESXI bridge cluster is deprecated and only Edge Bridge cluster is supported.

Request:

Method:

GET

URI Path(s):

/api/v1/bridge-clusters/<bridgecluster-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/bridge-clusters/07419c2e-3d0e-48af-b1d1-380ffb6f5943

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

BridgeCluster+

BridgeCluster (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_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
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
bridge_nodes	Nodes used in bridging	array of BridgeClusterNode	Maximum items: 2
cluster_profile_bindings	Bridge cluster profile bindings	array of ClusterProfileTypeIdEntry
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
resource_type	Must be set to the value BridgeCluster	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "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 }

Get Information about a bridge cluster (Deprecated)

Request:

Example Request:

Successful Response:

BridgeCluster (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: