NSX-T Data Center REST API

Returns information about the discovered zone

Returns information about a specific zone, along with the list of its associated clusters discovered from the compute manager

Request:

Method:

GET

URI Path(s):

/api/v1/fabric/zones/{zone-ext-id}

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/fabric/zones/ecd5d517-db8d-46cf-bf52-f7e3663b7232:california-zone

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

Zone+

Zone (schema)

Name	Description	Type	Notes
_last_sync_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_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
cm_local_id	Zone local id This is the zone id as is received from the compute manager, e.g. "california-zone"	string	Required Readonly
compute_collection_external_ids	Compute collection external ids Collection of external ids of the compute collections (clusters), that are associated with this zone	array of string	Required
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
external_id	External id of the zone Combination of zone's compute manager id and the zone id, e.g. "ecd5d517-db8d-46cf-bf52-f7e3663b7232:california-zone"	string	Required Readonly
origin_id	Zone origin id Id of the compute manager from where this zone was discovered, e.g. "ecd5d517-db8d-46cf-bf52-f7e3663b7232"	string	Required Readonly
resource_type	Must be set to the value Zone	string	Required
scope	List of scopes for discovered resource Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.	array of DiscoveredResourceScope
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "external_id": "ecd5d517-db8d-46cf-bf52-f7e3663b7232:california-zone", "description": "California Zone", "origin_id" : "ecd5d517-db8d-46cf-bf52-f7e3663b7232", "cm_local_id" : "california-zone", "compute_collection_external_ids" : [ "ecd5d517-db8d-46cf-bf52-f7e3663b7232:domain-c11", "ecd5d517-db8d-46cf-bf52-f7e3663b7232:domain-c12" ] }

Required Permissions:

read

Feature:

compute_managers_inventory

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