NSX-T Data Center REST API

Get current status of tier-1 DNS forwarder

Get current status of tier-1 DNS forwarder.
- no enforcement point path specified: Status will be evaluated on each enforcement
point.
- {enforcement_point_path}: Status will be evaluated only on the given enforcement
point.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/tier-1s/{tier-1-id}/dns-forwarder/status
/policy/api/v1/global-infra/tier-1s/{tier-1-id}/dns-forwarder/status
/policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/dns-forwarder/status

Request Headers:

n/a

Query Parameters:

PolicyRuntimeOnEpRequestParameters+

PolicyRuntimeOnEpRequestParameters (schema)

Name	Description	Type	Notes
enforcement_point_path	String Path of the enforcement point enforcement point path, forward slashes must be escaped using %2F.	string

Request Body:

n/a

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

AggregateDNSForwarderStatus+

AggregateDNSForwarderStatus (schema)

Name	Description	Type	Notes
intent_path	String path of the DNS forwarder intent String path of the DNS forwarder intent.	string	Required
status_per_enforcement_point	List of DNS forwarder status per enforcement point List of DNS forwarder status per enforcement point.	array of DNSForwarderStatusPerEnforcementPoint (Abstract type: pass one of the following concrete types) NsxTDNSForwarderStatus	Readonly

Example Response:

{ "status_per_enforcement_point": [ { "resource_type": "NsxTDNSForwarderStatus", "enforcement_point_path": "/infra/sites/default/enforcement-points/default", "timestamp": 1537263302625, "status": "UP" } ], "intent_path": "/infra/tier-1s/tier-1/dns-forwarder" }

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