NGINX · Schema

HTTP Location Zone

NginxHTTPLocationZone schema from NGINX Plus REST API

API GatewayCachingCloud NativeLoad BalancerOpen SourceReverse ProxyWeb Server

Properties

Name Type Description
requests integer The total number of client requests received from clients.
responses object The total number of responses sent to clients, the number of responses with status codes “1xx”, “2xx”, “3xx”, “4xx”, and “5xx”, and the
discarded integer The total number of requests completed without sending a response.
received integer The total number of bytes received from clients.
sent integer The total number of bytes sent to clients.
View JSON Schema on GitHub

JSON Schema

plus-http-api-nginx-http-location-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-http-location-zone-schema.json",
  "title": "HTTP Location Zone",
  "description": "NginxHTTPLocationZone schema from NGINX Plus REST API",
  "type": "object",
  "properties": {
    "requests": {
      "type": "integer",
      "description": "The total number of client requests received from clients.",
      "example": 31070465
    },
    "responses": {
      "description": "The total number of responses sent to clients, the number of responses with status codes \u201c<code>1xx</code>\u201d, \u201c<code>2xx</code>\u201d, \u201c<code>3xx</code>\u201d, \u201c<code>4xx</code>\u201d, and \u201c<code>5xx</code>\u201d, and the number of responses per each status code.",
      "type": "object",
      "readOnly": true,
      "properties": {
        "1xx": {
          "type": "integer",
          "description": "The number of responses with \u201c<code>1xx</code>\u201d status codes.",
          "readOnly": true,
          "example": 0
        },
        "2xx": {
          "type": "integer",
          "description": "The number of responses with \u201c<code>2xx</code>\u201d status codes.",
          "readOnly": true,
          "example": 0
        },
        "3xx": {
          "type": "integer",
          "description": "The number of responses with \u201c<code>3xx</code>\u201d status codes.",
          "readOnly": true,
          "example": 0
        },
        "4xx": {
          "type": "integer",
          "description": "The number of responses with \u201c<code>4xx</code>\u201d status codes.",
          "readOnly": true,
          "example": 0
        },
        "5xx": {
          "type": "integer",
          "description": "The number of responses with \u201c<code>5xx</code>\u201d status codes.",
          "readOnly": true,
          "example": 0
        },
        "codes": {
          "type": "object",
          "description": "The number of responses per each status code.",
          "readOnly": true,
          "properties": {
            "codeNumber": {
              "type": "integer",
              "description": "The number of responses with this particular status code.",
              "readOnly": true,
              "example": 0
            }
          },
          "example": {}
        },
        "total": {
          "type": "integer",
          "description": "The total number of responses sent to clients.",
          "readOnly": true,
          "example": 98765
        }
      },
      "example": 1234567
    },
    "discarded": {
      "type": "integer",
      "description": "The total number of requests completed without sending a response.",
      "example": 0
    },
    "received": {
      "type": "integer",
      "description": "The total number of bytes received from clients.",
      "example": 180157219
    },
    "sent": {
      "type": "integer",
      "description": "The total number of bytes sent to clients.",
      "example": 20183175459
    }
  },
  "example": {
    "requests": 706690,
    "responses": {
      "1xx": 0,
      "2xx": 699482,
      "3xx": 4522,
      "4xx": 907,
      "5xx": 266,
      "codes": {
        "200": 112674,
        "301": 4522,
        "404": 2504,
        "503": 266
      },
      "total": 705177
    },
    "discarded": 1513,
    "received": 172711587,
    "sent": 19415530115
  }
}