Method get
Returns the specified virtual host.
To get the list of all virtual hosts of an HTTP router, make a list request.
HTTP request
GET https://alb.api.cloud.yandex.net/apploadbalancer/v1/httpRouters/{httpRouterId}/virtualHosts/{virtualHostName}
Path parameters
Parameter | Description |
---|---|
httpRouterId | Required. ID of the HTTP router that the virtual host belongs to. To get the HTTP router ID, make a list request. |
virtualHostName | Required. Name of the virtual host to return. To get the virtual host name, make a list request. Value must match the regular expression |
Response
HTTP Code: 200 - OK
{
"name": "string",
"authority": [
"string"
],
"routes": [
{
"name": "string",
"routeOptions": {
"modifyRequestHeaders": [
{
"name": "string",
// `routes[].routeOptions.modifyRequestHeaders[]` includes only one of the fields `append`, `replace`, `remove`, `rename`
"append": "string",
"replace": "string",
"remove": true,
"rename": "string",
// end of the list of possible fields`routes[].routeOptions.modifyRequestHeaders[]`
}
],
"modifyResponseHeaders": [
{
"name": "string",
// `routes[].routeOptions.modifyResponseHeaders[]` includes only one of the fields `append`, `replace`, `remove`, `rename`
"append": "string",
"replace": "string",
"remove": true,
"rename": "string",
// end of the list of possible fields`routes[].routeOptions.modifyResponseHeaders[]`
}
]
},
// `routes[]` includes only one of the fields `http`, `grpc`
"http": {
"match": {
"httpMethod": [
"string"
],
"path": {
// `routes[].http.match.path` includes only one of the fields `exactMatch`, `prefixMatch`
"exactMatch": "string",
"prefixMatch": "string",
// end of the list of possible fields`routes[].http.match.path`
}
},
// `routes[].http` includes only one of the fields `route`, `redirect`, `directResponse`
"route": {
"backendGroupId": "string",
"timeout": "string",
"idleTimeout": "string",
"prefixRewrite": "string",
"upgradeTypes": [
"string"
],
// `routes[].http.route` includes only one of the fields `hostRewrite`, `autoHostRewrite`
"hostRewrite": "string",
"autoHostRewrite": true,
// end of the list of possible fields`routes[].http.route`
},
"redirect": {
"replaceScheme": "string",
"replaceHost": "string",
"replacePort": "string",
"removeQuery": true,
"responseCode": "string",
// `routes[].http.redirect` includes only one of the fields `replacePath`, `replacePrefix`
"replacePath": "string",
"replacePrefix": "string",
// end of the list of possible fields`routes[].http.redirect`
},
"directResponse": {
"status": "string",
"body": {
"text": "string"
}
},
// end of the list of possible fields`routes[].http`
},
"grpc": {
"match": {
"fqmn": {
// `routes[].grpc.match.fqmn` includes only one of the fields `exactMatch`, `prefixMatch`
"exactMatch": "string",
"prefixMatch": "string",
// end of the list of possible fields`routes[].grpc.match.fqmn`
}
},
// `routes[].grpc` includes only one of the fields `route`, `statusResponse`
"route": {
"backendGroupId": "string",
"maxTimeout": "string",
"idleTimeout": "string",
// `routes[].grpc.route` includes only one of the fields `hostRewrite`, `autoHostRewrite`
"hostRewrite": "string",
"autoHostRewrite": true,
// end of the list of possible fields`routes[].grpc.route`
},
"statusResponse": {
"status": "string"
},
// end of the list of possible fields`routes[].grpc`
},
// end of the list of possible fields`routes[]`
}
],
"modifyRequestHeaders": [
{
"name": "string",
// `modifyRequestHeaders[]` includes only one of the fields `append`, `replace`, `remove`, `rename`
"append": "string",
"replace": "string",
"remove": true,
"rename": "string",
// end of the list of possible fields`modifyRequestHeaders[]`
}
],
"modifyResponseHeaders": [
{
"name": "string",
// `modifyResponseHeaders[]` includes only one of the fields `append`, `replace`, `remove`, `rename`
"append": "string",
"replace": "string",
"remove": true,
"rename": "string",
// end of the list of possible fields`modifyResponseHeaders[]`
}
],
"routeOptions": {
"modifyRequestHeaders": [
{
"name": "string",
// `routeOptions.modifyRequestHeaders[]` includes only one of the fields `append`, `replace`, `remove`, `rename`
"append": "string",
"replace": "string",
"remove": true,
"rename": "string",
// end of the list of possible fields`routeOptions.modifyRequestHeaders[]`
}
],
"modifyResponseHeaders": [
{
"name": "string",
// `routeOptions.modifyResponseHeaders[]` includes only one of the fields `append`, `replace`, `remove`, `rename`
"append": "string",
"replace": "string",
"remove": true,
"rename": "string",
// end of the list of possible fields`routeOptions.modifyResponseHeaders[]`
}
]
}
}
A virtual host resource.
For details about the concept, see documentation.
Field | Description |
---|---|
name | string Required. Name of the virtual host. The name is unique within the HTTP router. |
authority[] | string List of domains that are attributed to the virtual host. The host is selected to process the request received by the load balancer if the domain specified in the HTTP/1.1 A wildcard asterisk character ( If not specified, all domains are attributed to the host, which is the same as specifying a |
routes[] | object Routes of the virtual host. A route contains a set of conditions (predicates) that are used by the load balancer to select the route for the request and an action on the request. For details about the concept, see documentation. The order of routes matters: the first route whose predicate matches the request is selected. The most specific routes should be at the top of the list, so that they are not overridden. For example, if the first HTTP route is configured, via |
routes[]. name |
string Required. Name of the route. |
routes[]. routeOptions |
object |
routes[]. routeOptions. modifyRequestHeaders[] |
object Apply the following modifications to the request headers. |
routes[]. routeOptions. modifyRequestHeaders[]. name |
string Name of the header. |
routes[]. routeOptions. modifyRequestHeaders[]. append |
string routes[].routeOptions.modifyRequestHeaders[] includes only one of the fields append , replace , remove , rename Appends the specified string to the header value. Variables defined for Envoy proxy are supported. |
routes[]. routeOptions. modifyRequestHeaders[]. replace |
string routes[].routeOptions.modifyRequestHeaders[] includes only one of the fields append , replace , remove , rename Replaces the value of the header with the specified string. Variables defined for Envoy proxy are supported. |
routes[]. routeOptions. modifyRequestHeaders[]. remove |
boolean (boolean) routes[].routeOptions.modifyRequestHeaders[] includes only one of the fields append , replace , remove , rename Removes the header. |
routes[]. routeOptions. modifyRequestHeaders[]. rename |
string routes[].routeOptions.modifyRequestHeaders[] includes only one of the fields append , replace , remove , rename Replaces the name of the header with the specified string. This operation is only supported for ALB Virtual Hosts. |
routes[]. routeOptions. modifyResponseHeaders[] |
object Apply the following modifications to the response headers. |
routes[]. routeOptions. modifyResponseHeaders[]. name |
string Name of the header. |
routes[]. routeOptions. modifyResponseHeaders[]. append |
string routes[].routeOptions.modifyResponseHeaders[] includes only one of the fields append , replace , remove , rename Appends the specified string to the header value. Variables defined for Envoy proxy are supported. |
routes[]. routeOptions. modifyResponseHeaders[]. replace |
string routes[].routeOptions.modifyResponseHeaders[] includes only one of the fields append , replace , remove , rename Replaces the value of the header with the specified string. Variables defined for Envoy proxy are supported. |
routes[]. routeOptions. modifyResponseHeaders[]. remove |
boolean (boolean) routes[].routeOptions.modifyResponseHeaders[] includes only one of the fields append , replace , remove , rename Removes the header. |
routes[]. routeOptions. modifyResponseHeaders[]. rename |
string routes[].routeOptions.modifyResponseHeaders[] includes only one of the fields append , replace , remove , rename Replaces the name of the header with the specified string. This operation is only supported for ALB Virtual Hosts. |
routes[]. http |
object HTTP route configuration. routes[] includes only one of the fields http , grpc |
routes[]. http. match |
object Condition (predicate) used to select the route. |
routes[]. http. match. httpMethod[] |
string HTTP method specified in the request. |
routes[]. http. match. path |
object Match settings for the path specified in the request. If not specified, the route matches all paths. A string matcher resource. |
routes[]. http. match. path. exactMatch |
string routes[].http.match.path includes only one of the fields exactMatch , prefixMatch Exact match string. |
routes[]. http. match. path. prefixMatch |
string routes[].http.match.path includes only one of the fields exactMatch , prefixMatch Prefix match string. |
routes[]. http. route |
object Forwards the request to a backend group for processing as configured. routes[].http includes only one of the fields route , redirect , directResponse |
routes[]. http. route. backendGroupId |
string Required. Backend group to forward requests to. Stream (TCP) backend groups are not supported. |
routes[]. http. route. timeout |
string Overall timeout for an HTTP connection between a load balancer node an a backend from the backend group: the maximum time the connection is kept alive for, regardless of whether data is transferred over it. If a connection times out, the load balancer responds to the client with a Default value: |
routes[]. http. route. idleTimeout |
string Idle timeout for an HTTP connection between a load balancer node an a backend from the backend group: the maximum time the connection is allowed to be idle, i.e. without any data transferred over it. Specifying meaningful values for both If a connection times out, the load balancer responds to the client with a If not specified, no idle timeout is used, and an alive connection may be idle for any duration (see |
routes[]. http. route. prefixRewrite |
string Replacement for the path prefix matched by For instance, if If not specified, the path is not changed. |
routes[]. http. route. upgradeTypes[] |
string Supported values for HTTP |
routes[]. http. route. hostRewrite |
string routes[].http.route includes only one of the fields hostRewrite , autoHostRewrite Host replacement. |
routes[]. http. route. autoHostRewrite |
boolean (boolean) routes[].http.route includes only one of the fields hostRewrite , autoHostRewrite Automatically replaces the host with that of the target. |
routes[]. http. redirect |
object Redirects the request as configured. routes[].http includes only one of the fields route , redirect , directResponse |
routes[]. http. redirect. replaceScheme |
string URI scheme replacement. If If not specified, the original scheme and port are used. |
routes[]. http. redirect. replaceHost |
string URI host replacement. If not specified, the original host is used. |
routes[]. http. redirect. replacePort |
string (int64) URI host replacement. If not specified, the original host is used. |
routes[]. http. redirect. removeQuery |
boolean (boolean) Removes URI query. |
routes[]. http. redirect. responseCode |
string HTTP status code to use in redirect responses.
|
routes[]. http. redirect. replacePath |
string routes[].http.redirect includes only one of the fields replacePath , replacePrefix Replacement for the whole path. |
routes[]. http. redirect. replacePrefix |
string routes[].http.redirect includes only one of the fields replacePath , replacePrefix Replacement for the path prefix matched by For instance, if |
routes[]. http. directResponse |
object Instructs the load balancer to respond directly as configured. routes[].http includes only one of the fields route , redirect , directResponse |
routes[]. http. directResponse. status |
string (int64) HTTP status code to use in responses. Acceptable values are 100 to 599, inclusive. |
routes[]. http. directResponse. body |
object Response body. A health check payload resource. |
routes[]. http. directResponse. body. text |
string Payload text. The string length in characters must be greater than 0. |
routes[]. grpc |
object gRPC route configuration. routes[] includes only one of the fields http , grpc |
routes[]. grpc. match |
object Condition (predicate) used to select the route. |
routes[]. grpc. match. fqmn |
object Match settings for gRPC service method called in the request. A match string must be a fully qualified method name, e.g. If not specified, the route matches all methods. A string matcher resource. |
routes[]. grpc. match. fqmn. exactMatch |
string routes[].grpc.match.fqmn includes only one of the fields exactMatch , prefixMatch Exact match string. |
routes[]. grpc. match. fqmn. prefixMatch |
string routes[].grpc.match.fqmn includes only one of the fields exactMatch , prefixMatch Prefix match string. |
routes[]. grpc. route |
object Forwards the request to a backend group for processing as configured. routes[].grpc includes only one of the fields route , statusResponse |
routes[]. grpc. route. backendGroupId |
string Required. Backend group to forward requests to. |
routes[]. grpc. route. maxTimeout |
string Overall timeout for an underlying HTTP connection between a load balancer node an a backend from the backend group: the maximum time the connection is kept alive for, regardless of whether data is transferred over it. If a client specifies a lower timeout in HTTP If a connection times out, the load balancer responds to the client with an Default value: |
routes[]. grpc. route. idleTimeout |
string Idle timeout for an underlying HTTP connection between a load balancer node an a backend from the backend group: the maximum time the connection is allowed to be idle, i.e. without any data transferred over it. Specifying meaningful values for both If a connection times out, the load balancer responds to the client with an If not specified, no idle timeout is used, and an alive connection may be idle for any duration (see |
routes[]. grpc. route. hostRewrite |
string routes[].grpc.route includes only one of the fields hostRewrite , autoHostRewrite Host replacement. |
routes[]. grpc. route. autoHostRewrite |
boolean (boolean) routes[].grpc.route includes only one of the fields hostRewrite , autoHostRewrite Automatically replaces the host with that of the target. |
routes[]. grpc. statusResponse |
object Instructs the load balancer to respond directly with a specified status. routes[].grpc includes only one of the fields route , statusResponse |
routes[]. grpc. statusResponse. status |
string gRPC status code to use in responses. gRPC status code supported for use in responses.
|
modifyRequestHeaders[] | object Deprecated, use route_options.modify_request_headers. |
modifyRequestHeaders[]. name |
string Name of the header. |
modifyRequestHeaders[]. append |
string modifyRequestHeaders[] includes only one of the fields append , replace , remove , rename Appends the specified string to the header value. Variables defined for Envoy proxy are supported. |
modifyRequestHeaders[]. replace |
string modifyRequestHeaders[] includes only one of the fields append , replace , remove , rename Replaces the value of the header with the specified string. Variables defined for Envoy proxy are supported. |
modifyRequestHeaders[]. remove |
boolean (boolean) modifyRequestHeaders[] includes only one of the fields append , replace , remove , rename Removes the header. |
modifyRequestHeaders[]. rename |
string modifyRequestHeaders[] includes only one of the fields append , replace , remove , rename Replaces the name of the header with the specified string. This operation is only supported for ALB Virtual Hosts. |
modifyResponseHeaders[] | object Deprecated, use route_options.modify_response_headers. |
modifyResponseHeaders[]. name |
string Name of the header. |
modifyResponseHeaders[]. append |
string modifyResponseHeaders[] includes only one of the fields append , replace , remove , rename Appends the specified string to the header value. Variables defined for Envoy proxy are supported. |
modifyResponseHeaders[]. replace |
string modifyResponseHeaders[] includes only one of the fields append , replace , remove , rename Replaces the value of the header with the specified string. Variables defined for Envoy proxy are supported. |
modifyResponseHeaders[]. remove |
boolean (boolean) modifyResponseHeaders[] includes only one of the fields append , replace , remove , rename Removes the header. |
modifyResponseHeaders[]. rename |
string modifyResponseHeaders[] includes only one of the fields append , replace , remove , rename Replaces the name of the header with the specified string. This operation is only supported for ALB Virtual Hosts. |
routeOptions | object |
routeOptions. modifyRequestHeaders[] |
object Apply the following modifications to the request headers. |
routeOptions. modifyRequestHeaders[]. name |
string Name of the header. |
routeOptions. modifyRequestHeaders[]. append |
string routeOptions.modifyRequestHeaders[] includes only one of the fields append , replace , remove , rename Appends the specified string to the header value. Variables defined for Envoy proxy are supported. |
routeOptions. modifyRequestHeaders[]. replace |
string routeOptions.modifyRequestHeaders[] includes only one of the fields append , replace , remove , rename Replaces the value of the header with the specified string. Variables defined for Envoy proxy are supported. |
routeOptions. modifyRequestHeaders[]. remove |
boolean (boolean) routeOptions.modifyRequestHeaders[] includes only one of the fields append , replace , remove , rename Removes the header. |
routeOptions. modifyRequestHeaders[]. rename |
string routeOptions.modifyRequestHeaders[] includes only one of the fields append , replace , remove , rename Replaces the name of the header with the specified string. This operation is only supported for ALB Virtual Hosts. |
routeOptions. modifyResponseHeaders[] |
object Apply the following modifications to the response headers. |
routeOptions. modifyResponseHeaders[]. name |
string Name of the header. |
routeOptions. modifyResponseHeaders[]. append |
string routeOptions.modifyResponseHeaders[] includes only one of the fields append , replace , remove , rename Appends the specified string to the header value. Variables defined for Envoy proxy are supported. |
routeOptions. modifyResponseHeaders[]. replace |
string routeOptions.modifyResponseHeaders[] includes only one of the fields append , replace , remove , rename Replaces the value of the header with the specified string. Variables defined for Envoy proxy are supported. |
routeOptions. modifyResponseHeaders[]. remove |
boolean (boolean) routeOptions.modifyResponseHeaders[] includes only one of the fields append , replace , remove , rename Removes the header. |
routeOptions. modifyResponseHeaders[]. rename |
string routeOptions.modifyResponseHeaders[] includes only one of the fields append , replace , remove , rename Replaces the name of the header with the specified string. This operation is only supported for ALB Virtual Hosts. |