NGINX · Schema

Resolver Zone

Statistics of DNS requests and responses per particular resolver zone.

API GatewayCachingCloud NativeLoad BalancerOpen SourceReverse ProxyWeb Server

Properties

Name Type Description
requests object
responses object
View JSON Schema on GitHub

JSON Schema

plus-http-api-nginx-resolver-zone-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/nginx/refs/heads/main/json-schema/plus-http-api-nginx-resolver-zone-schema.json",
  "title": "Resolver Zone",
  "description": "Statistics of DNS requests and responses per particular\n<a href=\"https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver_status_zone\">resolver zone</a>.\n",
  "type": "object",
  "properties": {
    "requests": {
      "type": "object",
      "readOnly": true,
      "properties": {
        "name": {
          "type": "integer",
          "description": "The total number of requests to resolve names to addresses.",
          "readOnly": true,
          "example": "my_shared_zone"
        },
        "srv": {
          "type": "integer",
          "description": "The total number of requests to resolve SRV records.",
          "readOnly": true,
          "example": 0
        },
        "addr": {
          "type": "integer",
          "description": "The total number of requests to resolve addresses to names.",
          "readOnly": true,
          "example": 0
        }
      },
      "example": 31070465
    },
    "responses": {
      "type": "object",
      "readOnly": true,
      "properties": {
        "noerror": {
          "type": "integer",
          "description": "The total number of successful responses.",
          "readOnly": true,
          "example": 0
        },
        "formerr": {
          "type": "integer",
          "description": "The total number of FORMERR (<literal>Format error</literal>) responses.",
          "readOnly": true,
          "example": 0
        },
        "servfail": {
          "type": "integer",
          "description": "The total number of SERVFAIL (<literal>Server failure</literal>) responses.",
          "readOnly": true,
          "example": 0
        },
        "nxdomain": {
          "type": "integer",
          "description": "The total number of NXDOMAIN (<literal>Host not found</literal>) responses.",
          "readOnly": true,
          "example": 0
        },
        "notimp": {
          "type": "integer",
          "description": "The total number of NOTIMP (<literal>Unimplemented</literal>) responses.",
          "readOnly": true,
          "example": 0
        },
        "refused": {
          "type": "integer",
          "description": "The total number of REFUSED (<literal>Operation refused</literal>) responses.",
          "readOnly": true,
          "example": 0
        },
        "timedout": {
          "type": "integer",
          "description": "The total number of timed out requests.",
          "readOnly": true,
          "example": 0
        },
        "unknown": {
          "type": "integer",
          "description": "The total number of requests completed with an unknown error.",
          "readOnly": true,
          "example": 0
        }
      },
      "example": 1234567
    }
  },
  "example": {
    "resolver_zone1": {
      "requests": {
        "name": 25460,
        "srv": 130,
        "addr": 2580
      },
      "responses": {
        "noerror": 26499,
        "formerr": 0,
        "servfail": 3,
        "nxdomain": 0,
        "notimp": 0,
        "refused": 0,
        "timedout": 243,
        "unknown": 478
      }
    }
  }
}