NSX-T Data Center REST API

Get current status of the given DNS forwarder (Deprecated)

Returns the current status of the given DNS forwarder.

Request:

Method:

GET

URI Path(s):

/api/v1/dns/forwarders/<forwarder-id>/status

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

TODO

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

DnsForwarderStatus+

DnsForwarderStatus (schema)

(Deprecated)

Name	Description	Type	Notes
active_node	Uuid of active transport node	string	Readonly
extra_message	Extra message, if available	string	Readonly
standby_node	Uuid of stand_by transport node. null if non-HA mode	string	Readonly
status	UP means the DNS forwarder is working correctly on the active transport node and the stand-by transport node (if present). Failover will occur if either node goes down. DOWN means the DNS forwarder is down on both active transport node and standby node (if present). The DNS forwarder does not function in this situation. Error means there is some error on one or both transport node, or no status was reported from one or both transport nodes. The dns forwarder may be working (or not working). NO_BACKUP means dns forwarder is working in only one transport node, either because it is down on the standby node, or no standby is configured. An forwarder outage will occur if the active node goes down.	string	Readonly Enum: UP, DOWN, ERROR, NO_BACKUP
timestamp	Time stamp of the current status, in ms	EpochMsTimestamp	Readonly

Required Permissions:

read

Feature:

aggregation_service_health_monitoring

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