Application Load Balancer API, REST: LoadBalancer.list
Lists application load balancers in the specified folder.
HTTP request
GET https://alb.api.cloud.yandex.net/apploadbalancer/v1/loadBalancers
Query parameters
Parameter | Description |
---|---|
folderId | Required. ID of the folder to list application load balancers in. To get the folder ID, make a list request. |
pageSize | The maximum number of results per page to return. If the number of available results is larger than Acceptable values are 0 to 1000, inclusive. |
pageToken | Page token. To get the next page of results, set The maximum string length in characters is 100. |
filter | A filter expression that filters application load balancers listed in the response. The expression must specify:
The maximum string length in characters is 1000. |
Response
HTTP Code: 200 - OK
{
"loadBalancers": [
{
"id": "string",
"name": "string",
"description": "string",
"folderId": "string",
"labels": "object",
"status": "string",
"regionId": "string",
"networkId": "string",
"listeners": [
{
"name": "string",
"endpoints": [
{
"addresses": [
{
// `loadBalancers[].listeners[].endpoints[].addresses[]` includes only one of the fields `externalIpv4Address`, `internalIpv4Address`, `externalIpv6Address`
"externalIpv4Address": {
"address": "string"
},
"internalIpv4Address": {
"address": "string",
"subnetId": "string"
},
"externalIpv6Address": {
"address": "string"
},
// end of the list of possible fields`loadBalancers[].listeners[].endpoints[].addresses[]`
}
],
"ports": [
"string"
]
}
],
// `loadBalancers[].listeners[]` includes only one of the fields `http`, `tls`, `stream`
"http": {
"handler": {
"httpRouterId": "string",
"rewriteRequestId": true,
// `loadBalancers[].listeners[].http.handler` includes only one of the fields `http2Options`, `allowHttp10`
"http2Options": {
"maxConcurrentStreams": "string"
},
"allowHttp10": true,
// end of the list of possible fields`loadBalancers[].listeners[].http.handler`
},
"redirects": {
"httpToHttps": true
}
},
"tls": {
"defaultHandler": {
"certificateIds": [
"string"
],
// `loadBalancers[].listeners[].tls.defaultHandler` includes only one of the fields `httpHandler`, `streamHandler`
"httpHandler": {
"httpRouterId": "string",
"rewriteRequestId": true,
// `loadBalancers[].listeners[].tls.defaultHandler.httpHandler` includes only one of the fields `http2Options`, `allowHttp10`
"http2Options": {
"maxConcurrentStreams": "string"
},
"allowHttp10": true,
// end of the list of possible fields`loadBalancers[].listeners[].tls.defaultHandler.httpHandler`
},
"streamHandler": {
"backendGroupId": "string"
},
// end of the list of possible fields`loadBalancers[].listeners[].tls.defaultHandler`
},
"sniHandlers": [
{
"name": "string",
"serverNames": [
"string"
],
"handler": {
"certificateIds": [
"string"
],
// `loadBalancers[].listeners[].tls.sniHandlers[].handler` includes only one of the fields `httpHandler`, `streamHandler`
"httpHandler": {
"httpRouterId": "string",
"rewriteRequestId": true,
// `loadBalancers[].listeners[].tls.sniHandlers[].handler.httpHandler` includes only one of the fields `http2Options`, `allowHttp10`
"http2Options": {
"maxConcurrentStreams": "string"
},
"allowHttp10": true,
// end of the list of possible fields`loadBalancers[].listeners[].tls.sniHandlers[].handler.httpHandler`
},
"streamHandler": {
"backendGroupId": "string"
},
// end of the list of possible fields`loadBalancers[].listeners[].tls.sniHandlers[].handler`
}
}
]
},
"stream": {
"handler": {
"backendGroupId": "string"
}
},
// end of the list of possible fields`loadBalancers[].listeners[]`
}
],
"allocationPolicy": {
"locations": [
{
"zoneId": "string",
"subnetId": "string",
"disableTraffic": true
}
]
},
"logGroupId": "string",
"securityGroupIds": [
"string"
],
"createdAt": "string",
"autoScalePolicy": {
"minZoneSize": "string",
"maxSize": "string"
},
"logOptions": {
"logGroupId": "string",
"discardRules": [
{
"httpCodes": [
"string"
],
"httpCodeIntervals": [
"string"
],
"grpcCodes": [
"string"
],
"discardPercent": "integer"
}
],
"disable": true
}
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
loadBalancers[] | object List of application load balancers in the specified folder. |
loadBalancers[]. id |
string ID of the application load balancer. Generated at creation time. |
loadBalancers[]. name |
string Name of the application load balancer. The name is unique within the folder. |
loadBalancers[]. description |
string Description of the application load balancer. |
loadBalancers[]. folderId |
string ID of the folder that the application load balancer belongs to. |
loadBalancers[]. labels |
object Application load balancer labels as |
loadBalancers[]. status |
string Status of the application load balancer.
|
loadBalancers[]. regionId |
string ID of the region that the application load balancer is located at. |
loadBalancers[]. networkId |
string ID of the network that the application load balancer belongs to. |
loadBalancers[]. listeners[] |
object Listeners that belong to the application load balancer. For details about the concept, see documentation. |
loadBalancers[]. listeners[]. name |
string Required. Name of the listener. The name is unique within the application load balancer. The string length in characters is 3-63. |
loadBalancers[]. listeners[]. endpoints[] |
object Endpoints of the listener. Endpoints are defined by their IP addresses and ports. |
loadBalancers[]. listeners[]. endpoints[]. addresses[] |
object Required. Endpoint public (external) and internal addresses. Must contain at least one element. |
loadBalancers[]. listeners[]. endpoints[]. addresses[]. externalIpv4Address |
object Public IPv4 endpoint address. loadBalancers[].listeners[].endpoints[].addresses[] includes only one of the fields externalIpv4Address , internalIpv4Address , externalIpv6Address |
loadBalancers[]. listeners[]. endpoints[]. addresses[]. externalIpv4Address. address |
string IPv4 address. |
loadBalancers[]. listeners[]. endpoints[]. addresses[]. internalIpv4Address |
object Internal IPv4 endpoint address. To enable the use of listeners with internal addresses, contact support. loadBalancers[].listeners[].endpoints[].addresses[] includes only one of the fields externalIpv4Address , internalIpv4Address , externalIpv6Address |
loadBalancers[]. listeners[]. endpoints[]. addresses[]. internalIpv4Address. address |
string IPv4 address. |
loadBalancers[]. listeners[]. endpoints[]. addresses[]. internalIpv4Address. subnetId |
string ID of the subnet that the address belongs to. |
loadBalancers[]. listeners[]. endpoints[]. addresses[]. externalIpv6Address |
object Public IPv6 endpoint address. loadBalancers[].listeners[].endpoints[].addresses[] includes only one of the fields externalIpv4Address , internalIpv4Address , externalIpv6Address |
loadBalancers[]. listeners[]. endpoints[]. addresses[]. externalIpv6Address. address |
string IPv6 address. |
loadBalancers[]. listeners[]. endpoints[]. ports[] |
string (int64) Required. Endpoint ports. Must contain at least one element. Acceptable values are 1 to 65535, inclusive. |
loadBalancers[]. listeners[]. http |
object Unencrypted HTTP listener settings. loadBalancers[].listeners[] includes only one of the fields http , tls , stream |
loadBalancers[]. listeners[]. http. handler |
object Settings for handling HTTP requests. Only one of An HTTP handler resource. |
loadBalancers[]. listeners[]. http. handler. httpRouterId |
string ID of the HTTP router processing requests. For details about the concept, see documentation. To get the list of all available HTTP routers, make a list request. |
loadBalancers[]. listeners[]. http. handler. rewriteRequestId |
boolean (boolean) When unset, will preserve the incoming x-request-id header, otherwise would rewrite it with a new value. |
loadBalancers[]. listeners[]. http. handler. http2Options |
object HTTP/2 settings. If specified, incoming HTTP/2 requests are supported by the listener. loadBalancers[].listeners[].http.handler includes only one of the fields http2Options , allowHttp10 |
loadBalancers[]. listeners[]. http. handler. http2Options. maxConcurrentStreams |
string (int64) Maximum number of concurrent HTTP/2 streams in a connection. |
loadBalancers[]. listeners[]. http. handler. allowHttp10 |
boolean (boolean) loadBalancers[].listeners[].http.handler includes only one of the fields http2Options , allowHttp10 Enables support for incoming HTTP/1.0 and HTTP/1.1 requests and disables it for HTTP/2 requests. |
loadBalancers[]. listeners[]. http. redirects |
object Redirects settings. Only one of A listener redirects resource. |
loadBalancers[]. listeners[]. http. redirects. httpToHttps |
boolean (boolean) Redirects all unencrypted HTTP requests to the same URI with scheme changed to The setting has the same effect as a single, catch-all |
loadBalancers[]. listeners[]. tls |
object TLS-encrypted HTTP or TCP stream listener settings. All handlers within a listener ( defaultHandler and sniHandlers ) must be of one type, HttpHandler or StreamHandler . Mixing HTTP and TCP stream traffic in a TLS-encrypted listener is not supported. loadBalancers[].listeners[] includes only one of the fields http , tls , stream |
loadBalancers[]. listeners[]. tls. defaultHandler |
object Required. Settings for handling requests by default, with Server Name Indication (SNI) not matching any of the A TLS-encrypted (HTTP or TCP stream) handler resource. |
loadBalancers[]. listeners[]. tls. defaultHandler. certificateIds[] |
string Required. ID's of the TLS server certificates from Certificate Manager. RSA and ECDSA certificates are supported, and only the first certificate of each type is used. Must contain at least one element. |
loadBalancers[]. listeners[]. tls. defaultHandler. httpHandler |
object HTTP handler. loadBalancers[].listeners[].tls.defaultHandler includes only one of the fields httpHandler , streamHandler |
loadBalancers[]. listeners[]. tls. defaultHandler. httpHandler. httpRouterId |
string ID of the HTTP router processing requests. For details about the concept, see documentation. To get the list of all available HTTP routers, make a list request. |
loadBalancers[]. listeners[]. tls. defaultHandler. httpHandler. rewriteRequestId |
boolean (boolean) When unset, will preserve the incoming x-request-id header, otherwise would rewrite it with a new value. |
loadBalancers[]. listeners[]. tls. defaultHandler. httpHandler. http2Options |
object HTTP/2 settings. If specified, incoming HTTP/2 requests are supported by the listener. loadBalancers[].listeners[].tls.defaultHandler.httpHandler includes only one of the fields http2Options , allowHttp10 |
loadBalancers[]. listeners[]. tls. defaultHandler. httpHandler. http2Options. maxConcurrentStreams |
string (int64) Maximum number of concurrent HTTP/2 streams in a connection. |
loadBalancers[]. listeners[]. tls. defaultHandler. httpHandler. allowHttp10 |
boolean (boolean) loadBalancers[].listeners[].tls.defaultHandler.httpHandler includes only one of the fields http2Options , allowHttp10 Enables support for incoming HTTP/1.0 and HTTP/1.1 requests and disables it for HTTP/2 requests. |
loadBalancers[]. listeners[]. tls. defaultHandler. streamHandler |
object Stream (TCP) handler. loadBalancers[].listeners[].tls.defaultHandler includes only one of the fields httpHandler , streamHandler |
loadBalancers[]. listeners[]. tls. defaultHandler. streamHandler. backendGroupId |
string Required. ID of the backend group processing requests. For details about the concept, see documentation. The backend group type, specified via [BackendGroup.backend], must be To get the list of all available backend groups, make a list request. |
loadBalancers[]. listeners[]. tls. sniHandlers[] |
object Settings for handling requests with Server Name Indication (SNI) matching one of |
loadBalancers[]. listeners[]. tls. sniHandlers[]. name |
string Required. Name of the SNI handler. |
loadBalancers[]. listeners[]. tls. sniHandlers[]. serverNames[] |
string Required. Server names that are matched by the SNI handler. Must contain at least one element. |
loadBalancers[]. listeners[]. tls. sniHandlers[]. handler |
object Required. Settings for handling requests with Server Name Indication (SNI) matching one of A TLS-encrypted (HTTP or TCP stream) handler resource. |
loadBalancers[]. listeners[]. tls. sniHandlers[]. handler. certificateIds[] |
string Required. ID's of the TLS server certificates from Certificate Manager. RSA and ECDSA certificates are supported, and only the first certificate of each type is used. Must contain at least one element. |
loadBalancers[]. listeners[]. tls. sniHandlers[]. handler. httpHandler |
object HTTP handler. loadBalancers[].listeners[].tls.sniHandlers[].handler includes only one of the fields httpHandler , streamHandler |
loadBalancers[]. listeners[]. tls. sniHandlers[]. handler. httpHandler. httpRouterId |
string ID of the HTTP router processing requests. For details about the concept, see documentation. To get the list of all available HTTP routers, make a list request. |
loadBalancers[]. listeners[]. tls. sniHandlers[]. handler. httpHandler. rewriteRequestId |
boolean (boolean) When unset, will preserve the incoming x-request-id header, otherwise would rewrite it with a new value. |
loadBalancers[]. listeners[]. tls. sniHandlers[]. handler. httpHandler. http2Options |
object HTTP/2 settings. If specified, incoming HTTP/2 requests are supported by the listener. loadBalancers[].listeners[].tls.sniHandlers[].handler.httpHandler includes only one of the fields http2Options , allowHttp10 |
loadBalancers[]. listeners[]. tls. sniHandlers[]. handler. httpHandler. http2Options. maxConcurrentStreams |
string (int64) Maximum number of concurrent HTTP/2 streams in a connection. |
loadBalancers[]. listeners[]. tls. sniHandlers[]. handler. httpHandler. allowHttp10 |
boolean (boolean) loadBalancers[].listeners[].tls.sniHandlers[].handler.httpHandler includes only one of the fields http2Options , allowHttp10 Enables support for incoming HTTP/1.0 and HTTP/1.1 requests and disables it for HTTP/2 requests. |
loadBalancers[]. listeners[]. tls. sniHandlers[]. handler. streamHandler |
object Stream (TCP) handler. loadBalancers[].listeners[].tls.sniHandlers[].handler includes only one of the fields httpHandler , streamHandler |
loadBalancers[]. listeners[]. tls. sniHandlers[]. handler. streamHandler. backendGroupId |
string Required. ID of the backend group processing requests. For details about the concept, see documentation. The backend group type, specified via [BackendGroup.backend], must be To get the list of all available backend groups, make a list request. |
loadBalancers[]. listeners[]. stream |
object Unencrypted stream (TCP) listener settings. loadBalancers[].listeners[] includes only one of the fields http , tls , stream |
loadBalancers[]. listeners[]. stream. handler |
object Required. Settings for handling stream (TCP) requests. A stream (TCP) handler resource. |
loadBalancers[]. listeners[]. stream. handler. backendGroupId |
string Required. ID of the backend group processing requests. For details about the concept, see documentation. The backend group type, specified via [BackendGroup.backend], must be To get the list of all available backend groups, make a list request. |
loadBalancers[]. allocationPolicy |
object Locality settings of the application load balancer. For details about the concept, see documentation. A locality settings (allocation policy) resource. |
loadBalancers[]. allocationPolicy. locations[] |
object Required. Availability zones and subnets that the application load balancer resides. The minimum number of elements is 1. |
loadBalancers[]. allocationPolicy. locations[]. zoneId |
string Required. ID of the availability zone where the application load balancer resides. Each availability zone can only be specified once. |
loadBalancers[]. allocationPolicy. locations[]. subnetId |
string ID of the subnet that the application load balancer belongs to. |
loadBalancers[]. allocationPolicy. locations[]. disableTraffic |
boolean (boolean) Disables the load balancer node in the specified availability zone. Backends in the availability zone are not directly affected by this setting. They still may receive traffic from the load balancer nodes in other availability zones, subject to |
loadBalancers[]. logGroupId |
string ID of the log group that stores access logs of the application load balancer. The logs can be accessed using a Cloud Functions trigger for Cloud Logs. |
loadBalancers[]. securityGroupIds[] |
string ID's of the security groups attributed to the application load balancer. For details about the concept, see documentation. |
loadBalancers[]. createdAt |
string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
loadBalancers[]. autoScalePolicy |
object Scaling settings of the application load balancer. The scaling settings relate to a special internal instance group which facilitates the balancer's work. Instances in this group are called resource units. The group is scaled automatically based on incoming load and within limitations specified in these settings. For details about the concept, see documentation. A resource for scaling settings of an application load balancer. |
loadBalancers[]. autoScalePolicy. minZoneSize |
string (int64) Lower limit for the number of resource units in each availability zone. If not specified previously (using other instruments such as management console), the default value is 2. To revert to it, specify it explicitly. The minimum value is 2. Acceptable values are 0 to 1000, inclusive. |
loadBalancers[]. autoScalePolicy. maxSize |
string (int64) Upper limit for the total number of resource units across all availability zones. If a positive value is specified, it must be at least If the value is 0, there is no upper limit. Acceptable values are 0 to 1000, inclusive. |
loadBalancers[]. logOptions |
object Cloud logging settings of the application load balancer. |
loadBalancers[]. logOptions. logGroupId |
string Cloud Logging log group ID to store access logs. If not set then logs will be stored in default log group for the folder where load balancer located. |
loadBalancers[]. logOptions. discardRules[] |
object ordered list of rules, first matching rule applies |
loadBalancers[]. logOptions. discardRules[]. httpCodes[] |
string (int64) HTTP codes that should be discarded. Acceptable values are 100 to 599, inclusive. |
loadBalancers[]. logOptions. discardRules[]. httpCodeIntervals[] |
string Groups of HTTP codes like 4xx that should be discarded. |
loadBalancers[]. logOptions. discardRules[]. grpcCodes[] |
string GRPC codes that should be discarded
|
loadBalancers[]. logOptions. discardRules[]. discardPercent |
integer (int64) Percent of logs to be discarded: 0 - keep all, 100 or unset - discard all Acceptable values are 0 to 100, inclusive. |
loadBalancers[]. logOptions. disable |
boolean (boolean) Do not send logs to Cloud Logging log group. |
nextPageToken | string Token for getting the next page of the list. If the number of results is greater than the specified pageSize, use Each subsequent page will have its own |