Resource URL: /platform/<<version=3>>/network/dnscache

    Overview: This resource exposes OneFS network dns cache settings.

     Methods: GET, PUT

********************************************************************************

Method GET: View network dns cache settings.

       URL: GET /platform/<<version=3>>/network/dnscache

There are no query arguments for this method.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "settings": {
          "type": "object", 
          "properties": {
            "testping_delta": {
              "required": true, 
              "minimum": 0, 
              "type": "integer", 
              "description": "Deltas for checking cbind cluster health", 
              "maximum": 60
            }, 
            "ttl_max_servfail": {
              "required": true, 
              "minimum": 0, 
              "type": "integer", 
              "description": "Upper bound on ttl for server failures", 
              "maximum": 3600
            }, 
            "eager_refresh": {
              "required": true, 
              "minimum": 0, 
              "type": "integer", 
              "description": "Lead time to refresh cache entries nearing expiration", 
              "maximum": 60
            }, 
            "ttl_max_other": {
              "required": true, 
              "minimum": 0, 
              "type": "integer", 
              "description": "Upper bound on ttl for non-nxdomain failures", 
              "maximum": 3600
            }, 
            "ttl_min_other": {
              "required": true, 
              "minimum": 0, 
              "type": "integer", 
              "description": "Lower bound on ttl for non-nxdomain failures", 
              "maximum": 3600
            }, 
            "cluster_timeout": {
              "required": true, 
              "minimum": 1, 
              "type": "integer", 
              "description": "Timeout value for calls made to other nodes in the cluster", 
              "maximum": 30
            }, 
            "ttl_min_nxdomain": {
              "required": true, 
              "minimum": 0, 
              "type": "integer", 
              "description": "Lower bound on ttl for nxdomain", 
              "maximum": 3600
            }, 
            "ttl_max_noerror": {
              "required": true, 
              "minimum": 0, 
              "type": "integer", 
              "description": "Upper bound on ttl for cache hits", 
              "maximum": 3600
            }, 
            "ttl_min_noerror": {
              "required": true, 
              "minimum": 0, 
              "type": "integer", 
              "description": "Lower bound on ttl for cache hits", 
              "maximum": 3600
            }, 
            "ttl_max_nxdomain": {
              "required": true, 
              "minimum": 0, 
              "type": "integer", 
              "description": "Upper bound on ttl for nxdomain", 
              "maximum": 3600
            }, 
            "cache_entry_limit": {
              "required": true, 
              "minimum": 1024, 
              "type": "integer", 
              "description": "DNS cache entry limit", 
              "maximum": 1048576
            }, 
            "ttl_min_servfail": {
              "required": true, 
              "minimum": 0, 
              "type": "integer", 
              "description": "Lower bound on ttl for server failures", 
              "maximum": 3600
            }, 
            "dns_timeout": {
              "required": true, 
              "minimum": 1, 
              "type": "integer", 
              "description": "Timeout value for calls made to the dns resolvers", 
              "maximum": 30
            }
          }
        }
      }
    }
  ]
}

********************************************************************************

Method PUT: Modify network dns cache settings.

       URL: PUT /platform/<<version=3>>/network/dnscache

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "properties": {
    "testping_delta": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Deltas for checking cbind cluster health", 
          "maximum": 60
        }
      ]
    }, 
    "ttl_max_servfail": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Upper bound on ttl for server failures", 
          "maximum": 3600
        }
      ]
    }, 
    "eager_refresh": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Lead time to refresh cache entries nearing expiration", 
          "maximum": 60
        }
      ]
    }, 
    "ttl_max_other": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Upper bound on ttl for non-nxdomain failures", 
          "maximum": 3600
        }
      ]
    }, 
    "ttl_min_other": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Lower bound on ttl for non-nxdomain failures", 
          "maximum": 3600
        }
      ]
    }, 
    "cluster_timeout": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 1, 
          "type": "integer", 
          "description": "Timeout value for calls made to other nodes in the cluster", 
          "maximum": 30
        }
      ]
    }, 
    "ttl_min_nxdomain": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Lower bound on ttl for nxdomain", 
          "maximum": 3600
        }
      ]
    }, 
    "ttl_max_noerror": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Upper bound on ttl for cache hits", 
          "maximum": 3600
        }
      ]
    }, 
    "ttl_min_noerror": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Lower bound on ttl for cache hits", 
          "maximum": 3600
        }
      ]
    }, 
    "ttl_max_nxdomain": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Upper bound on ttl for nxdomain", 
          "maximum": 3600
        }
      ]
    }, 
    "cache_entry_limit": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 1024, 
          "type": "integer", 
          "description": "DNS cache entry limit", 
          "maximum": 1048576
        }
      ]
    }, 
    "ttl_min_servfail": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Lower bound on ttl for server failures", 
          "maximum": 3600
        }
      ]
    }, 
    "dns_timeout": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 1, 
          "type": "integer", 
          "description": "Timeout value for calls made to the dns resolvers", 
          "maximum": 30
        }
      ]
    }
  }
}

There is no JSON response body for this method.
