{
"$schema": "https://json-structure.org/meta/core/v0/#",
"name": "HTTP Upstream Server",
"description": "Dynamically configurable parameters of an HTTP upstream\nserver:\n",
"type": "object",
"members": {
"id": {
"description": "The ID of the HTTP upstream server. The ID is assigned automatically and cannot be changed.",
"type": "int32",
"readOnly": true,
"example": 0
},
"server": {
"description": "Same as the address parameter of the HTTP upstream server. When adding a server, it is possible to specify it as a domain name. In this case, changes of the IP addresses that correspond to a domain name will be monitored and automatically applied to the upstream configuration without the need of restarting nginx. This requires the resolver directive in the \u201chttp\u201d block. See also the resolve parameter of the HTTP upstream server.",
"type": "string",
"example": "example-server"
},
"service": {
"description": "Same as the service parameter of the HTTP upstream server. This parameter cannot be changed.",
"type": "string",
"readOnly": true,
"example": "example-service"
},
"weight": {
"description": "Same as the weight parameter of the HTTP upstream server.",
"type": "int32",
"example": 0
},
"max_conns": {
"description": "Same as the max_conns parameter of the HTTP upstream server.",
"type": "int32",
"example": 0
},
"max_fails": {
"description": "Same as the max_fails parameter of the HTTP upstream server.",
"type": "int32",
"example": 0
},
"fail_timeout": {
"description": "Same as the fail_timeout parameter of the HTTP upstream server.",
"type": "string",
"example": "example-fail_timeout"
},
"slow_start": {
"description": "Same as the slow_start parameter of the HTTP upstream server.",
"type": "string",
"example": "example-slow_start"
},
"route": {
"description": "Same as the route parameter of the HTTP upstream server.",
"type": "string",
"example": "example-route"
},
"backup": {
"description": "When true, adds a backup server. This parameter cannot be changed.",
"type": "boolean",
"readOnly": true,
"example": false
},
"down": {
"description": "Same as the down parameter of the HTTP upstream server.",
"type": "boolean",
"example": false
},
"drain": {
"description": "Same as the drain parameter of the HTTP upstream server.",
"type": "boolean",
"example": false
},
"parent": {
"description": "Parent server ID of the resolved server. The ID is assigned automatically and cannot be changed.",
"type": "string",
"readOnly": true,
"example": "example-parent"
},
"host": {
"description": "Hostname of the resolved server. The hostname is assigned automatically and cannot be changed.",
"type": "string",
"readOnly": true,
"example": "example-host"
}
},
"example": {
"id": 1,
"server": "10.0.0.1:8089",
"weight": 4,
"max_conns": 0,
"max_fails": 0,
"fail_timeout": "10s",
"slow_start": "10s",
"route": "",
"backup": true,
"down": true
}
}