NGINX · JSON Structure

Plus Http Api Nginx Http Server Zone Structure

Type: object Properties: 0
API GatewayCachingCloud NativeLoad BalancerOpen SourceReverse ProxyWeb Server

HTTP Server Zone is a JSON Structure definition published by NGINX. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "name": "HTTP Server Zone",
  "type": "object",
  "members": {
    "processing": {
      "description": "The number of client requests that are currently being processed.",
      "type": "int32",
      "example": 1
    },
    "requests": {
      "description": "The total number of client requests received from clients.",
      "type": "int32",
      "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",
      "members": {
        "1xx": {
          "description": "The number of responses with \u201c<code>1xx</code>\u201d status codes.",
          "type": "int32",
          "readOnly": true,
          "example": 0
        },
        "2xx": {
          "description": "The number of responses with \u201c<code>2xx</code>\u201d status codes.",
          "type": "int32",
          "readOnly": true,
          "example": 0
        },
        "3xx": {
          "description": "The number of responses with \u201c<code>3xx</code>\u201d status codes.",
          "type": "int32",
          "readOnly": true,
          "example": 0
        },
        "4xx": {
          "description": "The number of responses with \u201c<code>4xx</code>\u201d status codes.",
          "type": "int32",
          "readOnly": true,
          "example": 0
        },
        "5xx": {
          "description": "The number of responses with \u201c<code>5xx</code>\u201d status codes.",
          "type": "int32",
          "readOnly": true,
          "example": 0
        },
        "codes": {
          "description": "The number of responses per each status code.",
          "type": "object",
          "members": {
            "codeNumber": {
              "description": "The number of responses with this particular status code.",
              "type": "int32",
              "readOnly": true,
              "example": 0
            }
          },
          "readOnly": true,
          "example": {}
        },
        "total": {
          "description": "The total number of responses sent to clients.",
          "type": "int32",
          "readOnly": true,
          "example": 98765
        }
      },
      "readOnly": true,
      "example": 1234567
    },
    "discarded": {
      "description": "The total number of requests completed without sending a response.",
      "type": "int32",
      "example": 0
    },
    "received": {
      "description": "The total number of bytes received from clients.",
      "type": "int32",
      "example": 180157219
    },
    "sent": {
      "description": "The total number of bytes sent to clients.",
      "type": "int32",
      "example": 20183175459
    },
    "ssl": {
      "type": "object",
      "members": {
        "handshakes": {
          "description": "The total number of successful SSL handshakes.",
          "type": "int32",
          "readOnly": true,
          "example": 79572
        },
        "handshakes_failed": {
          "description": "The total number of failed SSL handshakes.",
          "type": "int32",
          "readOnly": true,
          "example": 21025
        },
        "session_reuses": {
          "description": "The total number of session reuses during SSL handshake.",
          "type": "int32",
          "readOnly": true,
          "example": 15762
        },
        "no_common_protocol": {
          "description": "The number of SSL handshakes failed because of no common protocol.",
          "type": "int32",
          "example": 4
        },
        "no_common_cipher": {
          "description": "The number of SSL handshakes failed because of no shared cipher.",
          "type": "int32",
          "example": 2
        },
        "handshake_timeout": {
          "description": "The number of SSL handshakes failed because of a timeout.",
          "type": "int32",
          "example": 0
        },
        "peer_rejected_cert": {
          "description": "The number of failed SSL handshakes when nginx presented the certificate to the client but it was rejected with a corresponding alert message.",
          "type": "int32",
          "example": 0
        },
        "verify_failures": {
          "description": "SSL certificate verification errors",
          "type": "object",
          "members": {
            "no_cert": {
              "description": "A client did not provide the required certificate.",
              "type": "int32",
              "example": 0
            },
            "expired_cert": {
              "description": "An expired or not yet valid certificate was presented by a client.",
              "type": "int32",
              "example": 2
            },
            "revoked_cert": {
              "description": "A revoked certificate was presented by a client.",
              "type": "int32",
              "example": 1
            },
            "other": {
              "description": "Other SSL certificate verification errors.",
              "type": "int32",
              "example": 1
            }
          },
          "example": {}
        }
      },
      "readOnly": true,
      "example": {}
    }
  },
  "example": {
    "processing": 1,
    "requests": 706690,
    "responses": {
      "1xx": 0,
      "2xx": 699482,
      "3xx": 4522,
      "4xx": 907,
      "5xx": 266,
      "codes": {
        "200": 699482,
        "301": 4522,
        "404": 907,
        "503": 266
      },
      "total": 705177
    },
    "discarded": 1513,
    "received": 172711587,
    "sent": 19415530115,
    "ssl": {
      "handshakes": 104303,
      "handshakes_failed": 1421,
      "session_reuses": 54645,
      "no_common_protocol": 4,
      "no_common_cipher": 2,
      "handshake_timeout": 0,
      "peer_rejected_cert": 0,
      "verify_failures": {
        "no_cert": 0,
        "expired_cert": 2,
        "revoked_cert": 1,
        "other": 1
      }
    }
  }
}