List Failure Domains

Returns information about configured failure domains.

Request:

Method:

GET

URI Path(s):

/api/v1/failure-domains

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/failure-domains/

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

FailureDomainListResult+

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	Failure Domain Results Array of all failure domains including system generated default failure domain	array of FailureDomain	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "results": [ { "_revision": 0, "id": "c08d57bf-247d-4a5e-9acd-c5f2860e2872", "resource_type": "FailureDomain", "display_name": "default-system-failure-domain", "description": "default system created failure domain", "_last_modified_user": "admin", "_last_modified_time": 1412873095391, "_create_time": 1412873095391, "_create_user": "admin", "_system_owned": "true", "_schema": "/v1/schema/FailureDomain" }, { "_revision": 0, "id": "7c57c5a7-c742-4ee2-8fae-a9ac6a01309c", "resource_type": "FailureDomain", "display_name": "FD2", "description": "failure domain of rack2", "preferred_active_edge_services": "true", "_last_modified_user": "admin", "_last_modified_time": 1412873062407, "_create_time": 1412873062407, "_create_user": "admin", "_schema": "/v1/schema/FailureDomain" }, { "_revision": 0, "id": "c55ec097-0b53-4103-9426-18e135250c29", "resource_type": "FailureDomain", "display_name": "FD3", "description": "failure domain of rack3", "preferred_active_edge_services": "false", "_last_modified_user": "admin", "_last_modified_time": 1412877285032, "_create_time": 1412877285032, "_create_user": "admin", "_schema": "/v1/schema/FailureDomain" } ] }

List Failure Domains

Request:

Example Request:

Successful Response:

FailureDomainListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: