Developer Documentation
Get DNS Forwarder Status
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
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/tier-1s/{tier-1-id}/dns-forwarder/status
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Tier-1 id |
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| optional |
|
string | String Path of the enforcement point |
Response
Response
Response BodyResponse Body
200 OK returns
AggregateDNSForwarderStatus
{
"intent_path": "string",
"status_per_enforcement_point": [
{
"enforcement_point_path": "string",
"resource_type": "string"
}
]
}| Property Name | Type | Description |
|---|---|---|
| intent_path | string |
String path of the DNS forwarder intent. |
| status_per_enforcement_point | array of DNSForwarderStatusPerEnforcementPoint |
List of DNS forwarder status per enforcement point. |
Errors
| Code | Returns | Description |
|---|---|---|
| 412 | PreconditionFailed | Not available |
| 500 | InternalServerError | The server encountered an unexpected condition which prevented it from fulfilling the request. |
| 503 | ServiceUnavailable | The server is currently unavailable (because it is overloaded or down for maintenance). |
| 400 | BadRequest | The request cannot be fulfilled due to bad syntax. |
| 403 | Forbidden | The server understood the request, but is refusing to fulfill it. |
| 404 | Nothing | Not Found |
On This Page
DNS Forwarder Operations
delete
get
patch
