Application Load Balancer API, gRPC: LoadBalancerService
- Calls LoadBalancerService
- Get
- List
- ListLoadBalancersRequest
- ListLoadBalancersResponse
- LoadBalancer
- Listener
- Endpoint
- Address
- ExternalIpv4Address
- InternalIpv4Address
- ExternalIpv6Address
- HttpListener
- HttpHandler
- Http2Options
- Redirects
- TlsListener
- TlsHandler
- StreamHandler
- SniMatch
- StreamListener
- AllocationPolicy
- Location
- AutoScalePolicy
- LogOptions
- LogDiscardRule
- Create
- CreateLoadBalancerRequest
- ListenerSpec
- EndpointSpec
- AddressSpec
- ExternalIpv4AddressSpec
- InternalIpv4AddressSpec
- ExternalIpv6AddressSpec
- HttpListener
- HttpHandler
- Http2Options
- Redirects
- TlsListener
- TlsHandler
- StreamHandler
- SniMatch
- StreamListener
- AllocationPolicy
- Location
- AutoScalePolicy
- LogOptions
- LogDiscardRule
- Operation
- CreateLoadBalancerMetadata
- LoadBalancer
- Listener
- Endpoint
- Address
- ExternalIpv4Address
- InternalIpv4Address
- ExternalIpv6Address
- Update
- UpdateLoadBalancerRequest
- ListenerSpec
- EndpointSpec
- AddressSpec
- ExternalIpv4AddressSpec
- InternalIpv4AddressSpec
- ExternalIpv6AddressSpec
- HttpListener
- HttpHandler
- Http2Options
- Redirects
- TlsListener
- TlsHandler
- StreamHandler
- SniMatch
- StreamListener
- AllocationPolicy
- Location
- AutoScalePolicy
- LogOptions
- LogDiscardRule
- Operation
- UpdateLoadBalancerMetadata
- LoadBalancer
- Listener
- Endpoint
- Address
- ExternalIpv4Address
- InternalIpv4Address
- ExternalIpv6Address
- Delete
- Start
- StartLoadBalancerRequest
- Operation
- StartLoadBalancerMetadata
- LoadBalancer
- Listener
- Endpoint
- Address
- ExternalIpv4Address
- InternalIpv4Address
- ExternalIpv6Address
- HttpListener
- HttpHandler
- Http2Options
- Redirects
- TlsListener
- TlsHandler
- StreamHandler
- SniMatch
- StreamListener
- AllocationPolicy
- Location
- AutoScalePolicy
- LogOptions
- LogDiscardRule
- Stop
- StopLoadBalancerRequest
- Operation
- StopLoadBalancerMetadata
- LoadBalancer
- Listener
- Endpoint
- Address
- ExternalIpv4Address
- InternalIpv4Address
- ExternalIpv6Address
- HttpListener
- HttpHandler
- Http2Options
- Redirects
- TlsListener
- TlsHandler
- StreamHandler
- SniMatch
- StreamListener
- AllocationPolicy
- Location
- AutoScalePolicy
- LogOptions
- LogDiscardRule
- AddListener
- AddListenerRequest
- ListenerSpec
- EndpointSpec
- AddressSpec
- ExternalIpv4AddressSpec
- InternalIpv4AddressSpec
- ExternalIpv6AddressSpec
- HttpListener
- HttpHandler
- Http2Options
- Redirects
- TlsListener
- TlsHandler
- StreamHandler
- SniMatch
- StreamListener
- Operation
- AddListenerMetadata
- LoadBalancer
- Listener
- Endpoint
- Address
- ExternalIpv4Address
- InternalIpv4Address
- ExternalIpv6Address
- AllocationPolicy
- Location
- AutoScalePolicy
- LogOptions
- LogDiscardRule
- RemoveListener
- RemoveListenerRequest
- Operation
- RemoveListenerMetadata
- LoadBalancer
- Listener
- Endpoint
- Address
- ExternalIpv4Address
- InternalIpv4Address
- ExternalIpv6Address
- HttpListener
- HttpHandler
- Http2Options
- Redirects
- TlsListener
- TlsHandler
- StreamHandler
- SniMatch
- StreamListener
- AllocationPolicy
- Location
- AutoScalePolicy
- LogOptions
- LogDiscardRule
- UpdateListener
- UpdateListenerRequest
- ListenerSpec
- EndpointSpec
- AddressSpec
- ExternalIpv4AddressSpec
- InternalIpv4AddressSpec
- ExternalIpv6AddressSpec
- HttpListener
- HttpHandler
- Http2Options
- Redirects
- TlsListener
- TlsHandler
- StreamHandler
- SniMatch
- StreamListener
- Operation
- UpdateListenerMetadata
- LoadBalancer
- Listener
- Endpoint
- Address
- ExternalIpv4Address
- InternalIpv4Address
- ExternalIpv6Address
- AllocationPolicy
- Location
- AutoScalePolicy
- LogOptions
- LogDiscardRule
- AddSniMatch
- UpdateSniMatch
- RemoveSniMatch
- GetTargetStates
- ListOperations
A set of methods for managing application load balancers.
Call | Description |
---|---|
Get | Returns the specified application load balancer. |
List | Lists application load balancers in the specified folder. |
Create | Creates an application load balancer in the specified folder. |
Update | Updates the specified application load balancer. |
Delete | Deletes the specified application load balancer. |
Start | Starts the specified application load balancer. |
Stop | Stops the specified application load balancer. |
AddListener | Adds a listener to the specified application load balancer. |
RemoveListener | Deletes the specified listener. |
UpdateListener | Updates the specified listener of the specified application load balancer. |
AddSniMatch | Adds a SNI handler to the specified listener. |
UpdateSniMatch | Updates the specified SNI handler of the specified listener. |
RemoveSniMatch | Deletes the specified SNI handler. |
GetTargetStates | Returns the statuses of all targets of the specified backend group in all their availability zones. |
ListOperations | Lists operations for the specified application load balancer. |
Calls LoadBalancerService
Get
Returns the specified application load balancer.
To get the list of all available application load balancers, make a List request.
rpc Get (GetLoadBalancerRequest) returns (LoadBalancer)
GetLoadBalancerRequest
Field | Description |
---|---|
load_balancer_id | string Required. ID of the application load balancer to return. To get the application load balancer ID, make a LoadBalancerService.List request. |
LoadBalancer
Field | Description |
---|---|
id | string ID of the application load balancer. Generated at creation time. |
name | string Name of the application load balancer. The name is unique within the folder. |
description | string Description of the application load balancer. |
folder_id | string ID of the folder that the application load balancer belongs to. |
labels | map<string,string> Application load balancer labels as key:value pairs. For details about the concept, see documentation. |
status | enum Status Status of the application load balancer.
|
region_id | string ID of the region that the application load balancer is located at. |
network_id | string ID of the network that the application load balancer belongs to. |
listeners[] | Listener Listeners that belong to the application load balancer. For details about the concept, see documentation. |
allocation_policy | AllocationPolicy Locality settings of the application load balancer. For details about the concept, see documentation. |
log_group_id | 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. |
security_group_ids[] | string ID's of the security groups attributed to the application load balancer. For details about the concept, see documentation. |
created_at | google.protobuf.Timestamp Creation timestamp. |
auto_scale_policy | AutoScalePolicy 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. |
log_options | LogOptions Cloud logging settings of the application load balancer. |
Listener
Field | Description |
---|---|
name | string Required. Name of the listener. The name is unique within the application load balancer. The string length in characters is 3-63. |
endpoints[] | Endpoint Endpoints of the listener. Endpoints are defined by their IP addresses and ports. |
listener | oneof: http , tls or stream Listener type and settings. |
http | HttpListener Unencrypted HTTP listener settings. |
tls | TlsListener TLS-encrypted HTTP or TCP stream listener settings. All handlers within a listener (TlsListener.default_handler and TlsListener.sni_handlers) must be of one type, HttpHandler or StreamHandler. Mixing HTTP and TCP stream traffic in a TLS-encrypted listener is not supported. |
stream | StreamListener Unencrypted stream (TCP) listener settings. |
Endpoint
Field | Description |
---|---|
addresses[] | Address Endpoint public (external) and internal addresses. The number of elements must be greater than 0. |
ports[] | int64 Endpoint ports. The number of elements must be greater than 0. Acceptable values are 1 to 65535, inclusive. |
Address
Field | Description |
---|---|
address | oneof: external_ipv4_address , internal_ipv4_address or external_ipv6_address Endpoint address of one of the types: public (external) IPv4 address, internal IPv4 address, public IPv6 address. |
external_ipv4_address | ExternalIpv4Address Public IPv4 endpoint address. |
internal_ipv4_address | InternalIpv4Address Internal IPv4 endpoint address. To enable the use of listeners with internal addresses, contact support |
external_ipv6_address | ExternalIpv6Address Public IPv6 endpoint address. |
ExternalIpv4Address
Field | Description |
---|---|
address | string IPv4 address. |
InternalIpv4Address
Field | Description |
---|---|
address | string IPv4 address. |
subnet_id | string ID of the subnet that the address belongs to. |
ExternalIpv6Address
Field | Description |
---|---|
address | string IPv6 address. |
HttpListener
Field | Description |
---|---|
handler | HttpHandler Settings for handling HTTP requests. Only one of handler and redirects can be specified. |
redirects | Redirects Redirects settings. Only one of redirects and handler can be specified. |
HttpHandler
Field | Description |
---|---|
http_router_id | 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 HttpRouterService.List request. |
protocol_settings | oneof: http2_options or allow_http10 Protocol settings. For HTTPS (HTTP over TLS) connections, settings are applied to the protocol negotiated using TLS ALPN |
http2_options | Http2Options HTTP/2 settings. If specified, incoming HTTP/2 requests are supported by the listener. |
allow_http10 | bool Enables support for incoming HTTP/1.0 and HTTP/1.1 requests and disables it for HTTP/2 requests. |
rewrite_request_id | bool When unset, will preserve the incoming x-request-id header, otherwise would rewrite it with a new value. |
Http2Options
Field | Description |
---|---|
max_concurrent_streams | int64 Maximum number of concurrent HTTP/2 streams in a connection. |
Redirects
Field | Description |
---|---|
http_to_https | bool Redirects all unencrypted HTTP requests to the same URI with scheme changed to https . The setting has the same effect as a single, catch-all HttpRoute with RedirectAction.replace_scheme set to https . |
TlsListener
Field | Description |
---|---|
default_handler | TlsHandler Required. Settings for handling requests by default, with Server Name Indication (SNI) not matching any of the sni_handlers . |
sni_handlers[] | SniMatch Settings for handling requests with Server Name Indication (SNI) matching one of SniMatch.server_names values. |
TlsHandler
Field | Description |
---|---|
handler | oneof: http_handler or stream_handler Settings for handling requests. |
http_handler | HttpHandler HTTP handler. |
stream_handler | StreamHandler Stream (TCP) handler. |
certificate_ids[] | string 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. The number of elements must be greater than 0. |
StreamHandler
Field | Description |
---|---|
backend_group_id | 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 stream . To get the list of all available backend groups, make a BackendGroupService.List request. |
SniMatch
Field | Description |
---|---|
name | string Required. Name of the SNI handler. |
server_names[] | string Server names that are matched by the SNI handler. The number of elements must be greater than 0. |
handler | TlsHandler Required. Settings for handling requests with Server Name Indication (SNI) matching one of server_names values. |
StreamListener
Field | Description |
---|---|
handler | StreamHandler Required. Settings for handling stream (TCP) requests. |
AllocationPolicy
Field | Description |
---|---|
locations[] | Location Availability zones and subnets that the application load balancer resides. The minimum number of elements is 1. |
Location
Field | Description |
---|---|
zone_id | string Required. ID of the availability zone where the application load balancer resides. Each availability zone can only be specified once. |
subnet_id | string ID of the subnet that the application load balancer belongs to. |
disable_traffic | bool 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 LoadBalancingConfig.locality_aware_routing_percent and LoadBalancingConfig.strict_locality settings. |
AutoScalePolicy
Field | Description |
---|---|
min_zone_size | 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. |
max_size | 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 min_zone_size multiplied by the size of AllocationPolicy.locations. If the value is 0, there is no upper limit. Acceptable values are 0 to 1000, inclusive. |
LogOptions
Field | Description |
---|---|
log_group_id | 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. |
discard_rules[] | LogDiscardRule ordered list of rules, first matching rule applies |
disable | bool Do not send logs to Cloud Logging log group. |
LogDiscardRule
Field | Description |
---|---|
http_codes[] | int64 HTTP codes that should be discarded. Acceptable values are 100 to 599, inclusive. |
http_code_intervals[] | enum HttpCodeInterval Groups of HTTP codes like 4xx that should be discarded. |
grpc_codes[] | google.rpc.Code GRPC codes that should be discarded |
discard_percent | google.protobuf.Int64Value Percent of logs to be discarded: 0 - keep all, 100 or unset - discard all Acceptable values are 0 to 100, inclusive. |
List
Lists application load balancers in the specified folder.
rpc List (ListLoadBalancersRequest) returns (ListLoadBalancersResponse)
ListLoadBalancersRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder to list application load balancers in. To get the folder ID, make a yandex.cloud.resourcemanager.v1.FolderService.List request. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListLoadBalancersResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive. |
page_token | string Page token. To get the next page of results, set page_token to the ListLoadBalancersResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100. |
filter | string A filter expression that filters application load balancers listed in the response. The expression must specify:
name=my-load-balancer . The maximum string length in characters is 1000. |
ListLoadBalancersResponse
Field | Description |
---|---|
load_balancers[] | LoadBalancer List of application load balancers in the specified folder. |
next_page_token | string Token for getting the next page of the list. If the number of results is greater than the specified ListLoadBalancersRequest.page_size, use next_page_token as the value for the ListLoadBalancersRequest.page_token parameter in the next list request. Each subsequent page will have its own next_page_token to continue paging through the results. |
LoadBalancer
Field | Description |
---|---|
id | string ID of the application load balancer. Generated at creation time. |
name | string Name of the application load balancer. The name is unique within the folder. |
description | string Description of the application load balancer. |
folder_id | string ID of the folder that the application load balancer belongs to. |
labels | map<string,string> Application load balancer labels as key:value pairs. For details about the concept, see documentation. |
status | enum Status Status of the application load balancer.
|
region_id | string ID of the region that the application load balancer is located at. |
network_id | string ID of the network that the application load balancer belongs to. |
listeners[] | Listener Listeners that belong to the application load balancer. For details about the concept, see documentation. |
allocation_policy | AllocationPolicy Locality settings of the application load balancer. For details about the concept, see documentation. |
log_group_id | 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. |
security_group_ids[] | string ID's of the security groups attributed to the application load balancer. For details about the concept, see documentation. |
created_at | google.protobuf.Timestamp Creation timestamp. |
auto_scale_policy | AutoScalePolicy 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. |
log_options | LogOptions Cloud logging settings of the application load balancer. |
Listener
Field | Description |
---|---|
name | string Required. Name of the listener. The name is unique within the application load balancer. The string length in characters is 3-63. |
endpoints[] | Endpoint Endpoints of the listener. Endpoints are defined by their IP addresses and ports. |
listener | oneof: http , tls or stream Listener type and settings. |
http | HttpListener Unencrypted HTTP listener settings. |
tls | TlsListener TLS-encrypted HTTP or TCP stream listener settings. All handlers within a listener (TlsListener.default_handler and TlsListener.sni_handlers) must be of one type, HttpHandler or StreamHandler. Mixing HTTP and TCP stream traffic in a TLS-encrypted listener is not supported. |
stream | StreamListener Unencrypted stream (TCP) listener settings. |
Endpoint
Field | Description |
---|---|
addresses[] | Address Endpoint public (external) and internal addresses. The number of elements must be greater than 0. |
ports[] | int64 Endpoint ports. The number of elements must be greater than 0. Acceptable values are 1 to 65535, inclusive. |
Address
Field | Description |
---|---|
address | oneof: external_ipv4_address , internal_ipv4_address or external_ipv6_address Endpoint address of one of the types: public (external) IPv4 address, internal IPv4 address, public IPv6 address. |
external_ipv4_address | ExternalIpv4Address Public IPv4 endpoint address. |
internal_ipv4_address | InternalIpv4Address Internal IPv4 endpoint address. To enable the use of listeners with internal addresses, contact support |
external_ipv6_address | ExternalIpv6Address Public IPv6 endpoint address. |
ExternalIpv4Address
Field | Description |
---|---|
address | string IPv4 address. |
InternalIpv4Address
Field | Description |
---|---|
address | string IPv4 address. |
subnet_id | string ID of the subnet that the address belongs to. |
ExternalIpv6Address
Field | Description |
---|---|
address | string IPv6 address. |
HttpListener
Field | Description |
---|---|
handler | HttpHandler Settings for handling HTTP requests. Only one of handler and redirects can be specified. |
redirects | Redirects Redirects settings. Only one of redirects and handler can be specified. |
HttpHandler
Field | Description |
---|---|
http_router_id | 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 HttpRouterService.List request. |
protocol_settings | oneof: http2_options or allow_http10 Protocol settings. For HTTPS (HTTP over TLS) connections, settings are applied to the protocol negotiated using TLS ALPN |
http2_options | Http2Options HTTP/2 settings. If specified, incoming HTTP/2 requests are supported by the listener. |
allow_http10 | bool Enables support for incoming HTTP/1.0 and HTTP/1.1 requests and disables it for HTTP/2 requests. |
rewrite_request_id | bool When unset, will preserve the incoming x-request-id header, otherwise would rewrite it with a new value. |
Http2Options
Field | Description |
---|---|
max_concurrent_streams | int64 Maximum number of concurrent HTTP/2 streams in a connection. |
Redirects
Field | Description |
---|---|
http_to_https | bool Redirects all unencrypted HTTP requests to the same URI with scheme changed to https . The setting has the same effect as a single, catch-all HttpRoute with RedirectAction.replace_scheme set to https . |
TlsListener
Field | Description |
---|---|
default_handler | TlsHandler Required. Settings for handling requests by default, with Server Name Indication (SNI) not matching any of the sni_handlers . |
sni_handlers[] | SniMatch Settings for handling requests with Server Name Indication (SNI) matching one of SniMatch.server_names values. |
TlsHandler
Field | Description |
---|---|
handler | oneof: http_handler or stream_handler Settings for handling requests. |
http_handler | HttpHandler HTTP handler. |
stream_handler | StreamHandler Stream (TCP) handler. |
certificate_ids[] | string 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. The number of elements must be greater than 0. |
StreamHandler
Field | Description |
---|---|
backend_group_id | 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 stream . To get the list of all available backend groups, make a BackendGroupService.List request. |
SniMatch
Field | Description |
---|---|
name | string Required. Name of the SNI handler. |
server_names[] | string Server names that are matched by the SNI handler. The number of elements must be greater than 0. |
handler | TlsHandler Required. Settings for handling requests with Server Name Indication (SNI) matching one of server_names values. |
StreamListener
Field | Description |
---|---|
handler | StreamHandler Required. Settings for handling stream (TCP) requests. |
AllocationPolicy
Field | Description |
---|---|
locations[] | Location Availability zones and subnets that the application load balancer resides. The minimum number of elements is 1. |
Location
Field | Description |
---|---|
zone_id | string Required. ID of the availability zone where the application load balancer resides. Each availability zone can only be specified once. |
subnet_id | string ID of the subnet that the application load balancer belongs to. |
disable_traffic | bool 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 LoadBalancingConfig.locality_aware_routing_percent and LoadBalancingConfig.strict_locality settings. |
AutoScalePolicy
Field | Description |
---|---|
min_zone_size | 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. |
max_size | 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 min_zone_size multiplied by the size of AllocationPolicy.locations. If the value is 0, there is no upper limit. Acceptable values are 0 to 1000, inclusive. |
LogOptions
Field | Description |
---|---|
log_group_id | 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. |
discard_rules[] | LogDiscardRule ordered list of rules, first matching rule applies |
disable | bool Do not send logs to Cloud Logging log group. |
LogDiscardRule
Field | Description |
---|---|
http_codes[] | int64 HTTP codes that should be discarded. Acceptable values are 100 to 599, inclusive. |
http_code_intervals[] | enum HttpCodeInterval Groups of HTTP codes like 4xx that should be discarded. |
grpc_codes[] | google.rpc.Code GRPC codes that should be discarded |
discard_percent | google.protobuf.Int64Value Percent of logs to be discarded: 0 - keep all, 100 or unset - discard all Acceptable values are 0 to 100, inclusive. |
Create
Creates an application load balancer in the specified folder.
rpc Create (CreateLoadBalancerRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateLoadBalancerMetadata
Operation.response:LoadBalancer
CreateLoadBalancerRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder to create an application load balancer in. To get the folder ID, make a yandex.cloud.resourcemanager.v1.FolderService.List request. |
name | string Name of the application load balancer. The name must be unique within the folder. Value must match the regular expression ([a-z]([-a-z0-9]{0,61}[a-z0-9])?)? . |
description | string Description of the application load balancer. The maximum string length in characters is 256. |
labels | map<string,string> Application load balancer labels as key:value pairs. For details about the concept, see documentation. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\\@0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
region_id | string Required. ID of the region that the application load balancer is located at. The only supported value is ru-central1 . |
network_id | string Required. ID of the network that the application load balancer belongs to. |
listener_specs[] | ListenerSpec Listeners that belong to the application load balancer. For details about the concept, see documentation. |
allocation_policy | AllocationPolicy Locality settings of the application load balancer. For details about the concept, see documentation. |
security_group_ids[] | string ID's of the security groups attributed to the application load balancer. For details about the concept, see documentation. |
auto_scale_policy | AutoScalePolicy 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. |
log_options | LogOptions Cloud logging settings of the application load balancer. |
ListenerSpec
Field | Description |
---|---|
name | string Required. Name of the listener. The name is unique within the application load balancer. Value must match the regular expression [a-z]([-a-z0-9]{0,61}[a-z0-9])? . |
endpoint_specs[] | EndpointSpec Endpoints of the listener. Endpoints are defined by their IP addresses and ports. The number of elements must be greater than 0. |
listener | oneof: http , tls or stream Listener type and settings. |
http | HttpListener Unencrypted HTTP listener settings. |
tls | TlsListener TLS-encrypted HTTP or TCP stream listener settings. All handlers within a listener (TlsListener.default_handler and TlsListener.sni_handlers) must be of one type, HttpHandler or StreamHandler. Mixing HTTP and TCP stream traffic in a TLS-encrypted listener is not supported. |
stream | StreamListener Unencrypted stream (TCP) listener settings. |
EndpointSpec
Field | Description |
---|---|
address_specs[] | AddressSpec Endpoint public (external) and internal addresses. The number of elements must be greater than 0. |
ports[] | int64 Endpoint ports. The number of elements must be greater than 0. Acceptable values are 1 to 65535, inclusive. |
AddressSpec
Field | Description |
---|---|
address_spec | oneof: external_ipv4_address_spec , internal_ipv4_address_spec or external_ipv6_address_spec Endpoint address of one of the types: public (external) IPv4 address, internal IPv4 address, public IPv6 address. |
external_ipv4_address_spec | ExternalIpv4AddressSpec Public IPv4 endpoint address. |
internal_ipv4_address_spec | InternalIpv4AddressSpec Internal IPv4 endpoint address. To enable the use of listeners with internal addresses, contact support |
external_ipv6_address_spec | ExternalIpv6AddressSpec Public IPv6 endpoint address. |
ExternalIpv4AddressSpec
Field | Description |
---|---|
address | string IPv4 address. |
InternalIpv4AddressSpec
Field | Description |
---|---|
address | string IPv4 address. |
subnet_id | string ID of the subnet that the address belongs to. |
ExternalIpv6AddressSpec
Field | Description |
---|---|
address | string IPv6 address. |
HttpListener
Field | Description |
---|---|
handler | HttpHandler Settings for handling HTTP requests. Only one of handler and redirects can be specified. |
redirects | Redirects Redirects settings. Only one of redirects and handler can be specified. |
HttpHandler
Field | Description |
---|---|
http_router_id | 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 HttpRouterService.List request. |
protocol_settings | oneof: http2_options or allow_http10 Protocol settings. For HTTPS (HTTP over TLS) connections, settings are applied to the protocol negotiated using TLS ALPN |
http2_options | Http2Options HTTP/2 settings. If specified, incoming HTTP/2 requests are supported by the listener. |
allow_http10 | bool Enables support for incoming HTTP/1.0 and HTTP/1.1 requests and disables it for HTTP/2 requests. |
rewrite_request_id | bool When unset, will preserve the incoming x-request-id header, otherwise would rewrite it with a new value. |
Http2Options
Field | Description |
---|---|
max_concurrent_streams | int64 Maximum number of concurrent HTTP/2 streams in a connection. |
Redirects
Field | Description |
---|---|
http_to_https | bool Redirects all unencrypted HTTP requests to the same URI with scheme changed to https . The setting has the same effect as a single, catch-all HttpRoute with RedirectAction.replace_scheme set to https . |
TlsListener
Field | Description |
---|---|
default_handler | TlsHandler Required. Settings for handling requests by default, with Server Name Indication (SNI) not matching any of the sni_handlers . |
sni_handlers[] | SniMatch Settings for handling requests with Server Name Indication (SNI) matching one of SniMatch.server_names values. |
TlsHandler
Field | Description |
---|---|
handler | oneof: http_handler or stream_handler Settings for handling requests. |
http_handler | HttpHandler HTTP handler. |
stream_handler | StreamHandler Stream (TCP) handler. |
certificate_ids[] | string 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. The number of elements must be greater than 0. |
StreamHandler
Field | Description |
---|---|
backend_group_id | 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 stream . To get the list of all available backend groups, make a BackendGroupService.List request. |
SniMatch
Field | Description |
---|---|
name | string Required. Name of the SNI handler. |
server_names[] | string Server names that are matched by the SNI handler. The number of elements must be greater than 0. |
handler | TlsHandler Required. Settings for handling requests with Server Name Indication (SNI) matching one of server_names values. |
StreamListener
Field | Description |
---|---|
handler | StreamHandler Required. Settings for handling stream (TCP) requests. |
AllocationPolicy
Field | Description |
---|---|
locations[] | Location Availability zones and subnets that the application load balancer resides. The minimum number of elements is 1. |
Location
Field | Description |
---|---|
zone_id | string Required. ID of the availability zone where the application load balancer resides. Each availability zone can only be specified once. |
subnet_id | string ID of the subnet that the application load balancer belongs to. |
disable_traffic | bool 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 LoadBalancingConfig.locality_aware_routing_percent and LoadBalancingConfig.strict_locality settings. |
AutoScalePolicy
Field | Description |
---|---|
min_zone_size | 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. |
max_size | 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 min_zone_size multiplied by the size of AllocationPolicy.locations. If the value is 0, there is no upper limit. Acceptable values are 0 to 1000, inclusive. |
LogOptions
Field | Description |
---|---|
log_group_id | 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. |
discard_rules[] | LogDiscardRule ordered list of rules, first matching rule applies |
disable | bool Do not send logs to Cloud Logging log group. |
LogDiscardRule
Field | Description |
---|---|
http_codes[] | int64 HTTP codes that should be discarded. Acceptable values are 100 to 599, inclusive. |
http_code_intervals[] | enum HttpCodeInterval Groups of HTTP codes like 4xx that should be discarded. |
grpc_codes[] | google.rpc.Code GRPC codes that should be discarded |
discard_percent | google.protobuf.Int64Value Percent of logs to be discarded: 0 - keep all, 100 or unset - discard all Acceptable values are 0 to 100, inclusive. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
CreateLoadBalancerMetadata
Field | Description |
---|---|
load_balancer_id | string ID of the application load balancer that is being created. |
LoadBalancer
Field | Description |
---|---|
id | string ID of the application load balancer. Generated at creation time. |
name | string Name of the application load balancer. The name is unique within the folder. |
description | string Description of the application load balancer. |
folder_id | string ID of the folder that the application load balancer belongs to. |
labels | map<string,string> Application load balancer labels as key:value pairs. For details about the concept, see documentation. |
status | enum Status Status of the application load balancer.
|
region_id | string ID of the region that the application load balancer is located at. |
network_id | string ID of the network that the application load balancer belongs to. |
listeners[] | Listener Listeners that belong to the application load balancer. For details about the concept, see documentation. |
allocation_policy | AllocationPolicy Locality settings of the application load balancer. For details about the concept, see documentation. |
log_group_id | 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. |
security_group_ids[] | string ID's of the security groups attributed to the application load balancer. For details about the concept, see documentation. |
created_at | google.protobuf.Timestamp Creation timestamp. |
auto_scale_policy | AutoScalePolicy 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. |
log_options | LogOptions Cloud logging settings of the application load balancer. |
Listener
Field | Description |
---|---|
name | string Required. Name of the listener. The name is unique within the application load balancer. The string length in characters is 3-63. |
endpoints[] | Endpoint Endpoints of the listener. Endpoints are defined by their IP addresses and ports. |
listener | oneof: http , tls or stream Listener type and settings. |
http | HttpListener Unencrypted HTTP listener settings. |
tls | TlsListener TLS-encrypted HTTP or TCP stream listener settings. All handlers within a listener (TlsListener.default_handler and TlsListener.sni_handlers) must be of one type, HttpHandler or StreamHandler. Mixing HTTP and TCP stream traffic in a TLS-encrypted listener is not supported. |
stream | StreamListener Unencrypted stream (TCP) listener settings. |
Endpoint
Field | Description |
---|---|
addresses[] | Address Endpoint public (external) and internal addresses. The number of elements must be greater than 0. |
ports[] | int64 Endpoint ports. The number of elements must be greater than 0. Acceptable values are 1 to 65535, inclusive. |
Address
Field | Description |
---|---|
address | oneof: external_ipv4_address , internal_ipv4_address or external_ipv6_address Endpoint address of one of the types: public (external) IPv4 address, internal IPv4 address, public IPv6 address. |
external_ipv4_address | ExternalIpv4Address Public IPv4 endpoint address. |
internal_ipv4_address | InternalIpv4Address Internal IPv4 endpoint address. To enable the use of listeners with internal addresses, contact support |
external_ipv6_address | ExternalIpv6Address Public IPv6 endpoint address. |
ExternalIpv4Address
Field | Description |
---|---|
address | string IPv4 address. |
InternalIpv4Address
Field | Description |
---|---|
address | string IPv4 address. |
subnet_id | string ID of the subnet that the address belongs to. |
ExternalIpv6Address
Field | Description |
---|---|
address | string IPv6 address. |
Update
Updates the specified application load balancer.
rpc Update (UpdateLoadBalancerRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateLoadBalancerMetadata
Operation.response:LoadBalancer
UpdateLoadBalancerRequest
Field | Description |
---|---|
load_balancer_id | string Required. ID of the application load balancer to update. To get the application load balancer ID, make a LoadBalancerService.List request. |
update_mask | google.protobuf.FieldMask Field mask that specifies which attributes of the application load balancer should be updated. |
name | string New name for the application load balancer. The name must be unique within the folder. Value must match the regular expression ([a-z]([-a-z0-9]{0,61}[a-z0-9])?)? . |
description | string New description of the application load balancer. The maximum string length in characters is 256. |
labels | map<string,string> New application load balancer labels as key:value pairs. For details about the concept, see documentation. Existing set of labels is completely replaced by the provided set, so if you just want to add or remove a label:
[-_./\\@0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
listener_specs[] | ListenerSpec New listeners for the application load balancer. For details about the concept, see documentation. Existing list of listeners is completely replaced by the specified list, so if you just want to add, update, or remove a listener, make a LoadBalancerService.AddListener request, a LoadBalancerService.UpdateListener request, or a LoadBalancerService.RemoveListener request. |
allocation_policy | AllocationPolicy New locality settings of the application load balancer. For details about the concept, see documentation. Existing locality settings are completely replaced by the specified settings, so if you just want to add or remove an allocation policy:
|
security_group_ids[] | string ID's of new security groups attributed to the application load balancer. For details about the concept, see documentation. Existing list of security groups is completely replaced by the specified list, so if you just want to add or remove an allocation policy:
|
auto_scale_policy | AutoScalePolicy New 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. |
log_options | LogOptions Cloud logging settings of the application load balancer. |
ListenerSpec
Field | Description |
---|---|
name | string Required. Name of the listener. The name is unique within the application load balancer. Value must match the regular expression [a-z]([-a-z0-9]{0,61}[a-z0-9])? . |
endpoint_specs[] | EndpointSpec Endpoints of the listener. Endpoints are defined by their IP addresses and ports. The number of elements must be greater than 0. |
listener | oneof: http , tls or stream Listener type and settings. |
http | HttpListener Unencrypted HTTP listener settings. |
tls | TlsListener TLS-encrypted HTTP or TCP stream listener settings. All handlers within a listener (TlsListener.default_handler and TlsListener.sni_handlers) must be of one type, HttpHandler or StreamHandler. Mixing HTTP and TCP stream traffic in a TLS-encrypted listener is not supported. |
stream | StreamListener Unencrypted stream (TCP) listener settings. |
EndpointSpec
Field | Description |
---|---|
address_specs[] | AddressSpec Endpoint public (external) and internal addresses. The number of elements must be greater than 0. |
ports[] | int64 Endpoint ports. The number of elements must be greater than 0. Acceptable values are 1 to 65535, inclusive. |
AddressSpec
Field | Description |
---|---|
address_spec | oneof: external_ipv4_address_spec , internal_ipv4_address_spec or external_ipv6_address_spec Endpoint address of one of the types: public (external) IPv4 address, internal IPv4 address, public IPv6 address. |
external_ipv4_address_spec | ExternalIpv4AddressSpec Public IPv4 endpoint address. |
internal_ipv4_address_spec | InternalIpv4AddressSpec Internal IPv4 endpoint address. To enable the use of listeners with internal addresses, contact support |
external_ipv6_address_spec | ExternalIpv6AddressSpec Public IPv6 endpoint address. |
ExternalIpv4AddressSpec
Field | Description |
---|---|
address | string IPv4 address. |
InternalIpv4AddressSpec
Field | Description |
---|---|
address | string IPv4 address. |
subnet_id | string ID of the subnet that the address belongs to. |
ExternalIpv6AddressSpec
Field | Description |
---|---|
address | string IPv6 address. |
HttpListener
Field | Description |
---|---|
handler | HttpHandler Settings for handling HTTP requests. Only one of handler and redirects can be specified. |
redirects | Redirects Redirects settings. Only one of redirects and handler can be specified. |
HttpHandler
Field | Description |
---|---|
http_router_id | 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 HttpRouterService.List request. |
protocol_settings | oneof: http2_options or allow_http10 Protocol settings. For HTTPS (HTTP over TLS) connections, settings are applied to the protocol negotiated using TLS ALPN |
http2_options | Http2Options HTTP/2 settings. If specified, incoming HTTP/2 requests are supported by the listener. |
allow_http10 | bool Enables support for incoming HTTP/1.0 and HTTP/1.1 requests and disables it for HTTP/2 requests. |
rewrite_request_id | bool When unset, will preserve the incoming x-request-id header, otherwise would rewrite it with a new value. |
Http2Options
Field | Description |
---|---|
max_concurrent_streams | int64 Maximum number of concurrent HTTP/2 streams in a connection. |
Redirects
Field | Description |
---|---|
http_to_https | bool Redirects all unencrypted HTTP requests to the same URI with scheme changed to https . The setting has the same effect as a single, catch-all HttpRoute with RedirectAction.replace_scheme set to https . |
TlsListener
Field | Description |
---|---|
default_handler | TlsHandler Required. Settings for handling requests by default, with Server Name Indication (SNI) not matching any of the sni_handlers . |
sni_handlers[] | SniMatch Settings for handling requests with Server Name Indication (SNI) matching one of SniMatch.server_names values. |
TlsHandler
Field | Description |
---|---|
handler | oneof: http_handler or stream_handler Settings for handling requests. |
http_handler | HttpHandler HTTP handler. |
stream_handler | StreamHandler Stream (TCP) handler. |
certificate_ids[] | string 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. The number of elements must be greater than 0. |
StreamHandler
Field | Description |
---|---|
backend_group_id | 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 stream . To get the list of all available backend groups, make a BackendGroupService.List request. |
SniMatch
Field | Description |
---|---|
name | string Required. Name of the SNI handler. |
server_names[] | string Server names that are matched by the SNI handler. The number of elements must be greater than 0. |
handler | TlsHandler Required. Settings for handling requests with Server Name Indication (SNI) matching one of server_names values. |
StreamListener
Field | Description |
---|---|
handler | StreamHandler Required. Settings for handling stream (TCP) requests. |
AllocationPolicy
Field | Description |
---|---|
locations[] | Location Availability zones and subnets that the application load balancer resides. The minimum number of elements is 1. |
Location
Field | Description |
---|---|
zone_id | string Required. ID of the availability zone where the application load balancer resides. Each availability zone can only be specified once. |
subnet_id | string ID of the subnet that the application load balancer belongs to. |
disable_traffic | bool 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 LoadBalancingConfig.locality_aware_routing_percent and LoadBalancingConfig.strict_locality settings. |
AutoScalePolicy
Field | Description |
---|---|
min_zone_size | 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. |
max_size | 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 min_zone_size multiplied by the size of AllocationPolicy.locations. If the value is 0, there is no upper limit. Acceptable values are 0 to 1000, inclusive. |
LogOptions
Field | Description |
---|---|
log_group_id | 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. |
discard_rules[] | LogDiscardRule ordered list of rules, first matching rule applies |
disable | bool Do not send logs to Cloud Logging log group. |
LogDiscardRule
Field | Description |
---|---|
http_codes[] | int64 HTTP codes that should be discarded. Acceptable values are 100 to 599, inclusive. |
http_code_intervals[] | enum HttpCodeInterval Groups of HTTP codes like 4xx that should be discarded. |
grpc_codes[] | google.rpc.Code GRPC codes that should be discarded |
discard_percent | google.protobuf.Int64Value Percent of logs to be discarded: 0 - keep all, 100 or unset - discard all Acceptable values are 0 to 100, inclusive. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateLoadBalancerMetadata
Field | Description |
---|---|
load_balancer_id | string ID of the application load balancer that is being updated. |
LoadBalancer
Field | Description |
---|---|
id | string ID of the application load balancer. Generated at creation time. |
name | string Name of the application load balancer. The name is unique within the folder. |
description | string Description of the application load balancer. |
folder_id | string ID of the folder that the application load balancer belongs to. |
labels | map<string,string> Application load balancer labels as key:value pairs. For details about the concept, see documentation. |
status | enum Status Status of the application load balancer.
|
region_id | string ID of the region that the application load balancer is located at. |
network_id | string ID of the network that the application load balancer belongs to. |
listeners[] | Listener Listeners that belong to the application load balancer. For details about the concept, see documentation. |
allocation_policy | AllocationPolicy Locality settings of the application load balancer. For details about the concept, see documentation. |
log_group_id | 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. |
security_group_ids[] | string ID's of the security groups attributed to the application load balancer. For details about the concept, see documentation. |
created_at | google.protobuf.Timestamp Creation timestamp. |
auto_scale_policy | AutoScalePolicy 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. |
log_options | LogOptions Cloud logging settings of the application load balancer. |
Listener
Field | Description |
---|---|
name | string Required. Name of the listener. The name is unique within the application load balancer. The string length in characters is 3-63. |
endpoints[] | Endpoint Endpoints of the listener. Endpoints are defined by their IP addresses and ports. |
listener | oneof: http , tls or stream Listener type and settings. |
http | HttpListener Unencrypted HTTP listener settings. |
tls | TlsListener TLS-encrypted HTTP or TCP stream listener settings. All handlers within a listener (TlsListener.default_handler and TlsListener.sni_handlers) must be of one type, HttpHandler or StreamHandler. Mixing HTTP and TCP stream traffic in a TLS-encrypted listener is not supported. |
stream | StreamListener Unencrypted stream (TCP) listener settings. |
Endpoint
Field | Description |
---|---|
addresses[] | Address Endpoint public (external) and internal addresses. The number of elements must be greater than 0. |
ports[] | int64 Endpoint ports. The number of elements must be greater than 0. Acceptable values are 1 to 65535, inclusive. |
Address
Field | Description |
---|---|
address | oneof: external_ipv4_address , internal_ipv4_address or external_ipv6_address Endpoint address of one of the types: public (external) IPv4 address, internal IPv4 address, public IPv6 address. |
external_ipv4_address | ExternalIpv4Address Public IPv4 endpoint address. |
internal_ipv4_address | InternalIpv4Address Internal IPv4 endpoint address. To enable the use of listeners with internal addresses, contact support |
external_ipv6_address | ExternalIpv6Address Public IPv6 endpoint address. |
ExternalIpv4Address
Field | Description |
---|---|
address | string IPv4 address. |
InternalIpv4Address
Field | Description |
---|---|
address | string IPv4 address. |
subnet_id | string ID of the subnet that the address belongs to. |
ExternalIpv6Address
Field | Description |
---|---|
address | string IPv6 address. |
Delete
Deletes the specified application load balancer.
rpc Delete (DeleteLoadBalancerRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteLoadBalancerMetadata
Operation.response:google.protobuf.Empty
DeleteLoadBalancerRequest
Field | Description |
---|---|
load_balancer_id | string Required. ID of the application load balancer to delete. To get the application load balancer ID, make a LoadBalancerService.List request. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeleteLoadBalancerMetadata
Field | Description |
---|---|
load_balancer_id | string ID of the application load balancer that is being deleted. |
Start
Starts the specified application load balancer.
rpc Start (StartLoadBalancerRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:StartLoadBalancerMetadata
Operation.response:LoadBalancer
StartLoadBalancerRequest
Field | Description |
---|---|
load_balancer_id | string Required. ID of the application load balancer to start. The application load balancer must have a STOPPED status (LoadBalancer.status). To get the application load balancer ID, make a LoadBalancerService.List request. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
StartLoadBalancerMetadata
Field | Description |
---|---|
load_balancer_id | string ID of the application load balancer that is being started. |
LoadBalancer
Field | Description |
---|---|
id | string ID of the application load balancer. Generated at creation time. |
name | string Name of the application load balancer. The name is unique within the folder. |
description | string Description of the application load balancer. |
folder_id | string ID of the folder that the application load balancer belongs to. |
labels | map<string,string> Application load balancer labels as key:value pairs. For details about the concept, see documentation. |
status | enum Status Status of the application load balancer.
|
region_id | string ID of the region that the application load balancer is located at. |
network_id | string ID of the network that the application load balancer belongs to. |
listeners[] | Listener Listeners that belong to the application load balancer. For details about the concept, see documentation. |
allocation_policy | AllocationPolicy Locality settings of the application load balancer. For details about the concept, see documentation. |
log_group_id | 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. |
security_group_ids[] | string ID's of the security groups attributed to the application load balancer. For details about the concept, see documentation. |
created_at | google.protobuf.Timestamp Creation timestamp. |
auto_scale_policy | AutoScalePolicy 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. |
log_options | LogOptions Cloud logging settings of the application load balancer. |
Listener
Field | Description |
---|---|
name | string Required. Name of the listener. The name is unique within the application load balancer. The string length in characters is 3-63. |
endpoints[] | Endpoint Endpoints of the listener. Endpoints are defined by their IP addresses and ports. |
listener | oneof: http , tls or stream Listener type and settings. |
http | HttpListener Unencrypted HTTP listener settings. |
tls | TlsListener TLS-encrypted HTTP or TCP stream listener settings. All handlers within a listener (TlsListener.default_handler and TlsListener.sni_handlers) must be of one type, HttpHandler or StreamHandler. Mixing HTTP and TCP stream traffic in a TLS-encrypted listener is not supported. |
stream | StreamListener Unencrypted stream (TCP) listener settings. |
Endpoint
Field | Description |
---|---|
addresses[] | Address Endpoint public (external) and internal addresses. The number of elements must be greater than 0. |
ports[] | int64 Endpoint ports. The number of elements must be greater than 0. Acceptable values are 1 to 65535, inclusive. |
Address
Field | Description |
---|---|
address | oneof: external_ipv4_address , internal_ipv4_address or external_ipv6_address Endpoint address of one of the types: public (external) IPv4 address, internal IPv4 address, public IPv6 address. |
external_ipv4_address | ExternalIpv4Address Public IPv4 endpoint address. |
internal_ipv4_address | InternalIpv4Address Internal IPv4 endpoint address. To enable the use of listeners with internal addresses, contact support |
external_ipv6_address | ExternalIpv6Address Public IPv6 endpoint address. |
ExternalIpv4Address
Field | Description |
---|---|
address | string IPv4 address. |
InternalIpv4Address
Field | Description |
---|---|
address | string IPv4 address. |
subnet_id | string ID of the subnet that the address belongs to. |
ExternalIpv6Address
Field | Description |
---|---|
address | string IPv6 address. |
HttpListener
Field | Description |
---|---|
handler | HttpHandler Settings for handling HTTP requests. Only one of handler and redirects can be specified. |
redirects | Redirects Redirects settings. Only one of redirects and handler can be specified. |
HttpHandler
Field | Description |
---|---|
http_router_id | 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 HttpRouterService.List request. |
protocol_settings | oneof: http2_options or allow_http10 Protocol settings. For HTTPS (HTTP over TLS) connections, settings are applied to the protocol negotiated using TLS ALPN |
http2_options | Http2Options HTTP/2 settings. If specified, incoming HTTP/2 requests are supported by the listener. |
allow_http10 | bool Enables support for incoming HTTP/1.0 and HTTP/1.1 requests and disables it for HTTP/2 requests. |
rewrite_request_id | bool When unset, will preserve the incoming x-request-id header, otherwise would rewrite it with a new value. |
Http2Options
Field | Description |
---|---|
max_concurrent_streams | int64 Maximum number of concurrent HTTP/2 streams in a connection. |
Redirects
Field | Description |
---|---|
http_to_https | bool Redirects all unencrypted HTTP requests to the same URI with scheme changed to https . The setting has the same effect as a single, catch-all HttpRoute with RedirectAction.replace_scheme set to https . |
TlsListener
Field | Description |
---|---|
default_handler | TlsHandler Required. Settings for handling requests by default, with Server Name Indication (SNI) not matching any of the sni_handlers . |
sni_handlers[] | SniMatch Settings for handling requests with Server Name Indication (SNI) matching one of SniMatch.server_names values. |
TlsHandler
Field | Description |
---|---|
handler | oneof: http_handler or stream_handler Settings for handling requests. |
http_handler | HttpHandler HTTP handler. |
stream_handler | StreamHandler Stream (TCP) handler. |
certificate_ids[] | string 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. The number of elements must be greater than 0. |
StreamHandler
Field | Description |
---|---|
backend_group_id | 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 stream . To get the list of all available backend groups, make a BackendGroupService.List request. |
SniMatch
Field | Description |
---|---|
name | string Required. Name of the SNI handler. |
server_names[] | string Server names that are matched by the SNI handler. The number of elements must be greater than 0. |
handler | TlsHandler Required. Settings for handling requests with Server Name Indication (SNI) matching one of server_names values. |
StreamListener
Field | Description |
---|---|
handler | StreamHandler Required. Settings for handling stream (TCP) requests. |
AllocationPolicy
Field | Description |
---|---|
locations[] | Location Availability zones and subnets that the application load balancer resides. The minimum number of elements is 1. |
Location
Field | Description |
---|---|
zone_id | string Required. ID of the availability zone where the application load balancer resides. Each availability zone can only be specified once. |
subnet_id | string ID of the subnet that the application load balancer belongs to. |
disable_traffic | bool 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 LoadBalancingConfig.locality_aware_routing_percent and LoadBalancingConfig.strict_locality settings. |
AutoScalePolicy
Field | Description |
---|---|
min_zone_size | 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. |
max_size | 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 min_zone_size multiplied by the size of AllocationPolicy.locations. If the value is 0, there is no upper limit. Acceptable values are 0 to 1000, inclusive. |
LogOptions
Field | Description |
---|---|
log_group_id | 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. |
discard_rules[] | LogDiscardRule ordered list of rules, first matching rule applies |
disable | bool Do not send logs to Cloud Logging log group. |
LogDiscardRule
Field | Description |
---|---|
http_codes[] | int64 HTTP codes that should be discarded. Acceptable values are 100 to 599, inclusive. |
http_code_intervals[] | enum HttpCodeInterval Groups of HTTP codes like 4xx that should be discarded. |
grpc_codes[] | google.rpc.Code GRPC codes that should be discarded |
discard_percent | google.protobuf.Int64Value Percent of logs to be discarded: 0 - keep all, 100 or unset - discard all Acceptable values are 0 to 100, inclusive. |
Stop
Stops the specified application load balancer.
rpc Stop (StopLoadBalancerRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:StopLoadBalancerMetadata
Operation.response:LoadBalancer
StopLoadBalancerRequest
Field | Description |
---|---|
load_balancer_id | string Required. ID of the application load balancer to stop. The application load balancer must have an ACTIVE status (LoadBalancer.status). To get the application load balancer ID, make a LoadBalancerService.List request. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
StopLoadBalancerMetadata
Field | Description |
---|---|
load_balancer_id | string ID of the application load balancer that is being stopped. |
LoadBalancer
Field | Description |
---|---|
id | string ID of the application load balancer. Generated at creation time. |
name | string Name of the application load balancer. The name is unique within the folder. |
description | string Description of the application load balancer. |
folder_id | string ID of the folder that the application load balancer belongs to. |
labels | map<string,string> Application load balancer labels as key:value pairs. For details about the concept, see documentation. |
status | enum Status Status of the application load balancer.
|
region_id | string ID of the region that the application load balancer is located at. |
network_id | string ID of the network that the application load balancer belongs to. |
listeners[] | Listener Listeners that belong to the application load balancer. For details about the concept, see documentation. |
allocation_policy | AllocationPolicy Locality settings of the application load balancer. For details about the concept, see documentation. |
log_group_id | 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. |
security_group_ids[] | string ID's of the security groups attributed to the application load balancer. For details about the concept, see documentation. |
created_at | google.protobuf.Timestamp Creation timestamp. |
auto_scale_policy | AutoScalePolicy 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. |
log_options | LogOptions Cloud logging settings of the application load balancer. |
Listener
Field | Description |
---|---|
name | string Required. Name of the listener. The name is unique within the application load balancer. The string length in characters is 3-63. |
endpoints[] | Endpoint Endpoints of the listener. Endpoints are defined by their IP addresses and ports. |
listener | oneof: http , tls or stream Listener type and settings. |
http | HttpListener Unencrypted HTTP listener settings. |
tls | TlsListener TLS-encrypted HTTP or TCP stream listener settings. All handlers within a listener (TlsListener.default_handler and TlsListener.sni_handlers) must be of one type, HttpHandler or StreamHandler. Mixing HTTP and TCP stream traffic in a TLS-encrypted listener is not supported. |
stream | StreamListener Unencrypted stream (TCP) listener settings. |
Endpoint
Field | Description |
---|---|
addresses[] | Address Endpoint public (external) and internal addresses. The number of elements must be greater than 0. |
ports[] | int64 Endpoint ports. The number of elements must be greater than 0. Acceptable values are 1 to 65535, inclusive. |
Address
Field | Description |
---|---|
address | oneof: external_ipv4_address , internal_ipv4_address or external_ipv6_address Endpoint address of one of the types: public (external) IPv4 address, internal IPv4 address, public IPv6 address. |
external_ipv4_address | ExternalIpv4Address Public IPv4 endpoint address. |
internal_ipv4_address | InternalIpv4Address Internal IPv4 endpoint address. To enable the use of listeners with internal addresses, contact support |
external_ipv6_address | ExternalIpv6Address Public IPv6 endpoint address. |
ExternalIpv4Address
Field | Description |
---|---|
address | string IPv4 address. |
InternalIpv4Address
Field | Description |
---|---|
address | string IPv4 address. |
subnet_id | string ID of the subnet that the address belongs to. |
ExternalIpv6Address
Field | Description |
---|---|
address | string IPv6 address. |
HttpListener
Field | Description |
---|---|
handler | HttpHandler Settings for handling HTTP requests. Only one of handler and redirects can be specified. |
redirects | Redirects Redirects settings. Only one of redirects and handler can be specified. |
HttpHandler
Field | Description |
---|---|
http_router_id | 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 HttpRouterService.List request. |
protocol_settings | oneof: http2_options or allow_http10 Protocol settings. For HTTPS (HTTP over TLS) connections, settings are applied to the protocol negotiated using TLS ALPN |
http2_options | Http2Options HTTP/2 settings. If specified, incoming HTTP/2 requests are supported by the listener. |
allow_http10 | bool Enables support for incoming HTTP/1.0 and HTTP/1.1 requests and disables it for HTTP/2 requests. |
rewrite_request_id | bool When unset, will preserve the incoming x-request-id header, otherwise would rewrite it with a new value. |
Http2Options
Field | Description |
---|---|
max_concurrent_streams | int64 Maximum number of concurrent HTTP/2 streams in a connection. |
Redirects
Field | Description |
---|---|
http_to_https | bool Redirects all unencrypted HTTP requests to the same URI with scheme changed to https . The setting has the same effect as a single, catch-all HttpRoute with RedirectAction.replace_scheme set to https . |
TlsListener
Field | Description |
---|---|
default_handler | TlsHandler Required. Settings for handling requests by default, with Server Name Indication (SNI) not matching any of the sni_handlers . |
sni_handlers[] | SniMatch Settings for handling requests with Server Name Indication (SNI) matching one of SniMatch.server_names values. |
TlsHandler
Field | Description |
---|---|
handler | oneof: http_handler or stream_handler Settings for handling requests. |
http_handler | HttpHandler HTTP handler. |
stream_handler | StreamHandler Stream (TCP) handler. |
certificate_ids[] | string 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. The number of elements must be greater than 0. |
StreamHandler
Field | Description |
---|---|
backend_group_id | 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 stream . To get the list of all available backend groups, make a BackendGroupService.List request. |
SniMatch
Field | Description |
---|---|
name | string Required. Name of the SNI handler. |
server_names[] | string Server names that are matched by the SNI handler. The number of elements must be greater than 0. |
handler | TlsHandler Required. Settings for handling requests with Server Name Indication (SNI) matching one of server_names values. |
StreamListener
Field | Description |
---|---|
handler | StreamHandler Required. Settings for handling stream (TCP) requests. |
AllocationPolicy
Field | Description |
---|---|
locations[] | Location Availability zones and subnets that the application load balancer resides. The minimum number of elements is 1. |
Location
Field | Description |
---|---|
zone_id | string Required. ID of the availability zone where the application load balancer resides. Each availability zone can only be specified once. |
subnet_id | string ID of the subnet that the application load balancer belongs to. |
disable_traffic | bool 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 LoadBalancingConfig.locality_aware_routing_percent and LoadBalancingConfig.strict_locality settings. |
AutoScalePolicy
Field | Description |
---|---|
min_zone_size | 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. |
max_size | 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 min_zone_size multiplied by the size of AllocationPolicy.locations. If the value is 0, there is no upper limit. Acceptable values are 0 to 1000, inclusive. |
LogOptions
Field | Description |
---|---|
log_group_id | 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. |
discard_rules[] | LogDiscardRule ordered list of rules, first matching rule applies |
disable | bool Do not send logs to Cloud Logging log group. |
LogDiscardRule
Field | Description |
---|---|
http_codes[] | int64 HTTP codes that should be discarded. Acceptable values are 100 to 599, inclusive. |
http_code_intervals[] | enum HttpCodeInterval Groups of HTTP codes like 4xx that should be discarded. |
grpc_codes[] | google.rpc.Code GRPC codes that should be discarded |
discard_percent | google.protobuf.Int64Value Percent of logs to be discarded: 0 - keep all, 100 or unset - discard all Acceptable values are 0 to 100, inclusive. |
AddListener
Adds a listener to the specified application load balancer.
rpc AddListener (AddListenerRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:AddListenerMetadata
Operation.response:LoadBalancer
AddListenerRequest
Field | Description |
---|---|
load_balancer_id | string Required. ID of the application load balancer to add a listener to. |
listener_spec | ListenerSpec Required. Listener to add to the application load balancer. |
ListenerSpec
Field | Description |
---|---|
name | string Required. Name of the listener. The name is unique within the application load balancer. Value must match the regular expression [a-z]([-a-z0-9]{0,61}[a-z0-9])? . |
endpoint_specs[] | EndpointSpec Endpoints of the listener. Endpoints are defined by their IP addresses and ports. The number of elements must be greater than 0. |
listener | oneof: http , tls or stream Listener type and settings. |
http | HttpListener Unencrypted HTTP listener settings. |
tls | TlsListener TLS-encrypted HTTP or TCP stream listener settings. All handlers within a listener (TlsListener.default_handler and TlsListener.sni_handlers) must be of one type, HttpHandler or StreamHandler. Mixing HTTP and TCP stream traffic in a TLS-encrypted listener is not supported. |
stream | StreamListener Unencrypted stream (TCP) listener settings. |
EndpointSpec
Field | Description |
---|---|
address_specs[] | AddressSpec Endpoint public (external) and internal addresses. The number of elements must be greater than 0. |
ports[] | int64 Endpoint ports. The number of elements must be greater than 0. Acceptable values are 1 to 65535, inclusive. |
AddressSpec
Field | Description |
---|---|
address_spec | oneof: external_ipv4_address_spec , internal_ipv4_address_spec or external_ipv6_address_spec Endpoint address of one of the types: public (external) IPv4 address, internal IPv4 address, public IPv6 address. |
external_ipv4_address_spec | ExternalIpv4AddressSpec Public IPv4 endpoint address. |
internal_ipv4_address_spec | InternalIpv4AddressSpec Internal IPv4 endpoint address. To enable the use of listeners with internal addresses, contact support |
external_ipv6_address_spec | ExternalIpv6AddressSpec Public IPv6 endpoint address. |
ExternalIpv4AddressSpec
Field | Description |
---|---|
address | string IPv4 address. |
InternalIpv4AddressSpec
Field | Description |
---|---|
address | string IPv4 address. |
subnet_id | string ID of the subnet that the address belongs to. |
ExternalIpv6AddressSpec
Field | Description |
---|---|
address | string IPv6 address. |
HttpListener
Field | Description |
---|---|
handler | HttpHandler Settings for handling HTTP requests. Only one of handler and redirects can be specified. |
redirects | Redirects Redirects settings. Only one of redirects and handler can be specified. |
HttpHandler
Field | Description |
---|---|
http_router_id | 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 HttpRouterService.List request. |
protocol_settings | oneof: http2_options or allow_http10 Protocol settings. For HTTPS (HTTP over TLS) connections, settings are applied to the protocol negotiated using TLS ALPN |
http2_options | Http2Options HTTP/2 settings. If specified, incoming HTTP/2 requests are supported by the listener. |
allow_http10 | bool Enables support for incoming HTTP/1.0 and HTTP/1.1 requests and disables it for HTTP/2 requests. |
rewrite_request_id | bool When unset, will preserve the incoming x-request-id header, otherwise would rewrite it with a new value. |
Http2Options
Field | Description |
---|---|
max_concurrent_streams | int64 Maximum number of concurrent HTTP/2 streams in a connection. |
Redirects
Field | Description |
---|---|
http_to_https | bool Redirects all unencrypted HTTP requests to the same URI with scheme changed to https . The setting has the same effect as a single, catch-all HttpRoute with RedirectAction.replace_scheme set to https . |
TlsListener
Field | Description |
---|---|
default_handler | TlsHandler Required. Settings for handling requests by default, with Server Name Indication (SNI) not matching any of the sni_handlers . |
sni_handlers[] | SniMatch Settings for handling requests with Server Name Indication (SNI) matching one of SniMatch.server_names values. |
TlsHandler
Field | Description |
---|---|
handler | oneof: http_handler or stream_handler Settings for handling requests. |
http_handler | HttpHandler HTTP handler. |
stream_handler | StreamHandler Stream (TCP) handler. |
certificate_ids[] | string 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. The number of elements must be greater than 0. |
StreamHandler
Field | Description |
---|---|
backend_group_id | 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 stream . To get the list of all available backend groups, make a BackendGroupService.List request. |
SniMatch
Field | Description |
---|---|
name | string Required. Name of the SNI handler. |
server_names[] | string Server names that are matched by the SNI handler. The number of elements must be greater than 0. |
handler | TlsHandler Required. Settings for handling requests with Server Name Indication (SNI) matching one of server_names values. |
StreamListener
Field | Description |
---|---|
handler | StreamHandler Required. Settings for handling stream (TCP) requests. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
AddListenerMetadata
Field | Description |
---|---|
load_balancer_id | string ID of the application load balancer that the listener is being added to. |
listener_name | string Name of the listener that is being added to the application load balancer. |
LoadBalancer
Field | Description |
---|---|
id | string ID of the application load balancer. Generated at creation time. |
name | string Name of the application load balancer. The name is unique within the folder. |
description | string Description of the application load balancer. |
folder_id | string ID of the folder that the application load balancer belongs to. |
labels | map<string,string> Application load balancer labels as key:value pairs. For details about the concept, see documentation. |
status | enum Status Status of the application load balancer.
|
region_id | string ID of the region that the application load balancer is located at. |
network_id | string ID of the network that the application load balancer belongs to. |
listeners[] | Listener Listeners that belong to the application load balancer. For details about the concept, see documentation. |
allocation_policy | AllocationPolicy Locality settings of the application load balancer. For details about the concept, see documentation. |
log_group_id | 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. |
security_group_ids[] | string ID's of the security groups attributed to the application load balancer. For details about the concept, see documentation. |
created_at | google.protobuf.Timestamp Creation timestamp. |
auto_scale_policy | AutoScalePolicy 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. |
log_options | LogOptions Cloud logging settings of the application load balancer. |
Listener
Field | Description |
---|---|
name | string Required. Name of the listener. The name is unique within the application load balancer. The string length in characters is 3-63. |
endpoints[] | Endpoint Endpoints of the listener. Endpoints are defined by their IP addresses and ports. |
listener | oneof: http , tls or stream Listener type and settings. |
http | HttpListener Unencrypted HTTP listener settings. |
tls | TlsListener TLS-encrypted HTTP or TCP stream listener settings. All handlers within a listener (TlsListener.default_handler and TlsListener.sni_handlers) must be of one type, HttpHandler or StreamHandler. Mixing HTTP and TCP stream traffic in a TLS-encrypted listener is not supported. |
stream | StreamListener Unencrypted stream (TCP) listener settings. |
Endpoint
Field | Description |
---|---|
addresses[] | Address Endpoint public (external) and internal addresses. The number of elements must be greater than 0. |
ports[] | int64 Endpoint ports. The number of elements must be greater than 0. Acceptable values are 1 to 65535, inclusive. |
Address
Field | Description |
---|---|
address | oneof: external_ipv4_address , internal_ipv4_address or external_ipv6_address Endpoint address of one of the types: public (external) IPv4 address, internal IPv4 address, public IPv6 address. |
external_ipv4_address | ExternalIpv4Address Public IPv4 endpoint address. |
internal_ipv4_address | InternalIpv4Address Internal IPv4 endpoint address. To enable the use of listeners with internal addresses, contact support |
external_ipv6_address | ExternalIpv6Address Public IPv6 endpoint address. |
ExternalIpv4Address
Field | Description |
---|---|
address | string IPv4 address. |
InternalIpv4Address
Field | Description |
---|---|
address | string IPv4 address. |
subnet_id | string ID of the subnet that the address belongs to. |
ExternalIpv6Address
Field | Description |
---|---|
address | string IPv6 address. |
AllocationPolicy
Field | Description |
---|---|
locations[] | Location Availability zones and subnets that the application load balancer resides. The minimum number of elements is 1. |
Location
Field | Description |
---|---|
zone_id | string Required. ID of the availability zone where the application load balancer resides. Each availability zone can only be specified once. |
subnet_id | string ID of the subnet that the application load balancer belongs to. |
disable_traffic | bool 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 LoadBalancingConfig.locality_aware_routing_percent and LoadBalancingConfig.strict_locality settings. |
AutoScalePolicy
Field | Description |
---|---|
min_zone_size | 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. |
max_size | 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 min_zone_size multiplied by the size of AllocationPolicy.locations. If the value is 0, there is no upper limit. Acceptable values are 0 to 1000, inclusive. |
LogOptions
Field | Description |
---|---|
log_group_id | 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. |
discard_rules[] | LogDiscardRule ordered list of rules, first matching rule applies |
disable | bool Do not send logs to Cloud Logging log group. |
LogDiscardRule
Field | Description |
---|---|
http_codes[] | int64 HTTP codes that should be discarded. Acceptable values are 100 to 599, inclusive. |
http_code_intervals[] | enum HttpCodeInterval Groups of HTTP codes like 4xx that should be discarded. |
grpc_codes[] | google.rpc.Code GRPC codes that should be discarded |
discard_percent | google.protobuf.Int64Value Percent of logs to be discarded: 0 - keep all, 100 or unset - discard all Acceptable values are 0 to 100, inclusive. |
RemoveListener
Deletes the specified listener.
rpc RemoveListener (RemoveListenerRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:RemoveListenerMetadata
Operation.response:LoadBalancer
RemoveListenerRequest
Field | Description |
---|---|
load_balancer_id | string Required. ID of the application load balancer to remove the listener from. |
name | string Required. Name of the listener to remove from the application load balancer. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
RemoveListenerMetadata
Field | Description |
---|---|
load_balancer_id | string ID of the application load balancer that the listener is being removed from. |
listener_name | string Name of the listener that is being removed from the application load balancer. |
LoadBalancer
Field | Description |
---|---|
id | string ID of the application load balancer. Generated at creation time. |
name | string Name of the application load balancer. The name is unique within the folder. |
description | string Description of the application load balancer. |
folder_id | string ID of the folder that the application load balancer belongs to. |
labels | map<string,string> Application load balancer labels as key:value pairs. For details about the concept, see documentation. |
status | enum Status Status of the application load balancer.
|
region_id | string ID of the region that the application load balancer is located at. |
network_id | string ID of the network that the application load balancer belongs to. |
listeners[] | Listener Listeners that belong to the application load balancer. For details about the concept, see documentation. |
allocation_policy | AllocationPolicy Locality settings of the application load balancer. For details about the concept, see documentation. |
log_group_id | 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. |
security_group_ids[] | string ID's of the security groups attributed to the application load balancer. For details about the concept, see documentation. |
created_at | google.protobuf.Timestamp Creation timestamp. |
auto_scale_policy | AutoScalePolicy 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. |
log_options | LogOptions Cloud logging settings of the application load balancer. |
Listener
Field | Description |
---|---|
name | string Required. Name of the listener. The name is unique within the application load balancer. The string length in characters is 3-63. |
endpoints[] | Endpoint Endpoints of the listener. Endpoints are defined by their IP addresses and ports. |
listener | oneof: http , tls or stream Listener type and settings. |
http | HttpListener Unencrypted HTTP listener settings. |
tls | TlsListener TLS-encrypted HTTP or TCP stream listener settings. All handlers within a listener (TlsListener.default_handler and TlsListener.sni_handlers) must be of one type, HttpHandler or StreamHandler. Mixing HTTP and TCP stream traffic in a TLS-encrypted listener is not supported. |
stream | StreamListener Unencrypted stream (TCP) listener settings. |
Endpoint
Field | Description |
---|---|
addresses[] | Address Endpoint public (external) and internal addresses. The number of elements must be greater than 0. |
ports[] | int64 Endpoint ports. The number of elements must be greater than 0. Acceptable values are 1 to 65535, inclusive. |
Address
Field | Description |
---|---|
address | oneof: external_ipv4_address , internal_ipv4_address or external_ipv6_address Endpoint address of one of the types: public (external) IPv4 address, internal IPv4 address, public IPv6 address. |
external_ipv4_address | ExternalIpv4Address Public IPv4 endpoint address. |
internal_ipv4_address | InternalIpv4Address Internal IPv4 endpoint address. To enable the use of listeners with internal addresses, contact support |
external_ipv6_address | ExternalIpv6Address Public IPv6 endpoint address. |
ExternalIpv4Address
Field | Description |
---|---|
address | string IPv4 address. |
InternalIpv4Address
Field | Description |
---|---|
address | string IPv4 address. |
subnet_id | string ID of the subnet that the address belongs to. |
ExternalIpv6Address
Field | Description |
---|---|
address | string IPv6 address. |
HttpListener
Field | Description |
---|---|
handler | HttpHandler Settings for handling HTTP requests. Only one of handler and redirects can be specified. |
redirects | Redirects Redirects settings. Only one of redirects and handler can be specified. |
HttpHandler
Field | Description |
---|---|
http_router_id | 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 HttpRouterService.List request. |
protocol_settings | oneof: http2_options or allow_http10 Protocol settings. For HTTPS (HTTP over TLS) connections, settings are applied to the protocol negotiated using TLS ALPN |
http2_options | Http2Options HTTP/2 settings. If specified, incoming HTTP/2 requests are supported by the listener. |
allow_http10 | bool Enables support for incoming HTTP/1.0 and HTTP/1.1 requests and disables it for HTTP/2 requests. |
rewrite_request_id | bool When unset, will preserve the incoming x-request-id header, otherwise would rewrite it with a new value. |
Http2Options
Field | Description |
---|---|
max_concurrent_streams | int64 Maximum number of concurrent HTTP/2 streams in a connection. |
Redirects
Field | Description |
---|---|
http_to_https | bool Redirects all unencrypted HTTP requests to the same URI with scheme changed to https . The setting has the same effect as a single, catch-all HttpRoute with RedirectAction.replace_scheme set to https . |
TlsListener
Field | Description |
---|---|
default_handler | TlsHandler Required. Settings for handling requests by default, with Server Name Indication (SNI) not matching any of the sni_handlers . |
sni_handlers[] | SniMatch Settings for handling requests with Server Name Indication (SNI) matching one of SniMatch.server_names values. |
TlsHandler
Field | Description |
---|---|
handler | oneof: http_handler or stream_handler Settings for handling requests. |
http_handler | HttpHandler HTTP handler. |
stream_handler | StreamHandler Stream (TCP) handler. |
certificate_ids[] | string 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. The number of elements must be greater than 0. |
StreamHandler
Field | Description |
---|---|
backend_group_id | 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 stream . To get the list of all available backend groups, make a BackendGroupService.List request. |
SniMatch
Field | Description |
---|---|
name | string Required. Name of the SNI handler. |
server_names[] | string Server names that are matched by the SNI handler. The number of elements must be greater than 0. |
handler | TlsHandler Required. Settings for handling requests with Server Name Indication (SNI) matching one of server_names values. |
StreamListener
Field | Description |
---|---|
handler | StreamHandler Required. Settings for handling stream (TCP) requests. |
AllocationPolicy
Field | Description |
---|---|
locations[] | Location Availability zones and subnets that the application load balancer resides. The minimum number of elements is 1. |
Location
Field | Description |
---|---|
zone_id | string Required. ID of the availability zone where the application load balancer resides. Each availability zone can only be specified once. |
subnet_id | string ID of the subnet that the application load balancer belongs to. |
disable_traffic | bool 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 LoadBalancingConfig.locality_aware_routing_percent and LoadBalancingConfig.strict_locality settings. |
AutoScalePolicy
Field | Description |
---|---|
min_zone_size | 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. |
max_size | 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 min_zone_size multiplied by the size of AllocationPolicy.locations. If the value is 0, there is no upper limit. Acceptable values are 0 to 1000, inclusive. |
LogOptions
Field | Description |
---|---|
log_group_id | 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. |
discard_rules[] | LogDiscardRule ordered list of rules, first matching rule applies |
disable | bool Do not send logs to Cloud Logging log group. |
LogDiscardRule
Field | Description |
---|---|
http_codes[] | int64 HTTP codes that should be discarded. Acceptable values are 100 to 599, inclusive. |
http_code_intervals[] | enum HttpCodeInterval Groups of HTTP codes like 4xx that should be discarded. |
grpc_codes[] | google.rpc.Code GRPC codes that should be discarded |
discard_percent | google.protobuf.Int64Value Percent of logs to be discarded: 0 - keep all, 100 or unset - discard all Acceptable values are 0 to 100, inclusive. |
UpdateListener
Updates the specified listener of the specified application load balancer.
rpc UpdateListener (UpdateListenerRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateListenerMetadata
Operation.response:LoadBalancer
UpdateListenerRequest
Field | Description |
---|---|
load_balancer_id | string Required. ID of the application load balancer to update the listener in. |
update_mask | google.protobuf.FieldMask Field mask that specifies which attributes of the listener should be updated. |
listener_spec | ListenerSpec Required. New attributes of the listener. |
ListenerSpec
Field | Description |
---|---|
name | string Required. Name of the listener. The name is unique within the application load balancer. Value must match the regular expression [a-z]([-a-z0-9]{0,61}[a-z0-9])? . |
endpoint_specs[] | EndpointSpec Endpoints of the listener. Endpoints are defined by their IP addresses and ports. The number of elements must be greater than 0. |
listener | oneof: http , tls or stream Listener type and settings. |
http | HttpListener Unencrypted HTTP listener settings. |
tls | TlsListener TLS-encrypted HTTP or TCP stream listener settings. All handlers within a listener (TlsListener.default_handler and TlsListener.sni_handlers) must be of one type, HttpHandler or StreamHandler. Mixing HTTP and TCP stream traffic in a TLS-encrypted listener is not supported. |
stream | StreamListener Unencrypted stream (TCP) listener settings. |
EndpointSpec
Field | Description |
---|---|
address_specs[] | AddressSpec Endpoint public (external) and internal addresses. The number of elements must be greater than 0. |
ports[] | int64 Endpoint ports. The number of elements must be greater than 0. Acceptable values are 1 to 65535, inclusive. |
AddressSpec
Field | Description |
---|---|
address_spec | oneof: external_ipv4_address_spec , internal_ipv4_address_spec or external_ipv6_address_spec Endpoint address of one of the types: public (external) IPv4 address, internal IPv4 address, public IPv6 address. |
external_ipv4_address_spec | ExternalIpv4AddressSpec Public IPv4 endpoint address. |
internal_ipv4_address_spec | InternalIpv4AddressSpec Internal IPv4 endpoint address. To enable the use of listeners with internal addresses, contact support |
external_ipv6_address_spec | ExternalIpv6AddressSpec Public IPv6 endpoint address. |
ExternalIpv4AddressSpec
Field | Description |
---|---|
address | string IPv4 address. |
InternalIpv4AddressSpec
Field | Description |
---|---|
address | string IPv4 address. |
subnet_id | string ID of the subnet that the address belongs to. |
ExternalIpv6AddressSpec
Field | Description |
---|---|
address | string IPv6 address. |
HttpListener
Field | Description |
---|---|
handler | HttpHandler Settings for handling HTTP requests. Only one of handler and redirects can be specified. |
redirects | Redirects Redirects settings. Only one of redirects and handler can be specified. |
HttpHandler
Field | Description |
---|---|
http_router_id | 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 HttpRouterService.List request. |
protocol_settings | oneof: http2_options or allow_http10 Protocol settings. For HTTPS (HTTP over TLS) connections, settings are applied to the protocol negotiated using TLS ALPN |
http2_options | Http2Options HTTP/2 settings. If specified, incoming HTTP/2 requests are supported by the listener. |
allow_http10 | bool Enables support for incoming HTTP/1.0 and HTTP/1.1 requests and disables it for HTTP/2 requests. |
rewrite_request_id | bool When unset, will preserve the incoming x-request-id header, otherwise would rewrite it with a new value. |
Http2Options
Field | Description |
---|---|
max_concurrent_streams | int64 Maximum number of concurrent HTTP/2 streams in a connection. |
Redirects
Field | Description |
---|---|
http_to_https | bool Redirects all unencrypted HTTP requests to the same URI with scheme changed to https . The setting has the same effect as a single, catch-all HttpRoute with RedirectAction.replace_scheme set to https . |
TlsListener
Field | Description |
---|---|
default_handler | TlsHandler Required. Settings for handling requests by default, with Server Name Indication (SNI) not matching any of the sni_handlers . |
sni_handlers[] | SniMatch Settings for handling requests with Server Name Indication (SNI) matching one of SniMatch.server_names values. |
TlsHandler
Field | Description |
---|---|
handler | oneof: http_handler or stream_handler Settings for handling requests. |
http_handler | HttpHandler HTTP handler. |
stream_handler | StreamHandler Stream (TCP) handler. |
certificate_ids[] | string 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. The number of elements must be greater than 0. |
StreamHandler
Field | Description |
---|---|
backend_group_id | 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 stream . To get the list of all available backend groups, make a BackendGroupService.List request. |
SniMatch
Field | Description |
---|---|
name | string Required. Name of the SNI handler. |
server_names[] | string Server names that are matched by the SNI handler. The number of elements must be greater than 0. |
handler | TlsHandler Required. Settings for handling requests with Server Name Indication (SNI) matching one of server_names values. |
StreamListener
Field | Description |
---|---|
handler | StreamHandler Required. Settings for handling stream (TCP) requests. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateListenerMetadata
Field | Description |
---|---|
load_balancer_id | string ID of the application load balancer that the listener is being updated in. |
listener_name | string Name of the listener that is being updated. |
LoadBalancer
Field | Description |
---|---|
id | string ID of the application load balancer. Generated at creation time. |
name | string Name of the application load balancer. The name is unique within the folder. |
description | string Description of the application load balancer. |
folder_id | string ID of the folder that the application load balancer belongs to. |
labels | map<string,string> Application load balancer labels as key:value pairs. For details about the concept, see documentation. |
status | enum Status Status of the application load balancer.
|
region_id | string ID of the region that the application load balancer is located at. |
network_id | string ID of the network that the application load balancer belongs to. |
listeners[] | Listener Listeners that belong to the application load balancer. For details about the concept, see documentation. |
allocation_policy | AllocationPolicy Locality settings of the application load balancer. For details about the concept, see documentation. |
log_group_id | 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. |
security_group_ids[] | string ID's of the security groups attributed to the application load balancer. For details about the concept, see documentation. |
created_at | google.protobuf.Timestamp Creation timestamp. |
auto_scale_policy | AutoScalePolicy 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. |
log_options | LogOptions Cloud logging settings of the application load balancer. |
Listener
Field | Description |
---|---|
name | string Required. Name of the listener. The name is unique within the application load balancer. The string length in characters is 3-63. |
endpoints[] | Endpoint Endpoints of the listener. Endpoints are defined by their IP addresses and ports. |
listener | oneof: http , tls or stream Listener type and settings. |
http | HttpListener Unencrypted HTTP listener settings. |
tls | TlsListener TLS-encrypted HTTP or TCP stream listener settings. All handlers within a listener (TlsListener.default_handler and TlsListener.sni_handlers) must be of one type, HttpHandler or StreamHandler. Mixing HTTP and TCP stream traffic in a TLS-encrypted listener is not supported. |
stream | StreamListener Unencrypted stream (TCP) listener settings. |
Endpoint
Field | Description |
---|---|
addresses[] | Address Endpoint public (external) and internal addresses. The number of elements must be greater than 0. |
ports[] | int64 Endpoint ports. The number of elements must be greater than 0. Acceptable values are 1 to 65535, inclusive. |
Address
Field | Description |
---|---|
address | oneof: external_ipv4_address , internal_ipv4_address or external_ipv6_address Endpoint address of one of the types: public (external) IPv4 address, internal IPv4 address, public IPv6 address. |
external_ipv4_address | ExternalIpv4Address Public IPv4 endpoint address. |
internal_ipv4_address | InternalIpv4Address Internal IPv4 endpoint address. To enable the use of listeners with internal addresses, contact support |
external_ipv6_address | ExternalIpv6Address Public IPv6 endpoint address. |
ExternalIpv4Address
Field | Description |
---|---|
address | string IPv4 address. |
InternalIpv4Address
Field | Description |
---|---|
address | string IPv4 address. |
subnet_id | string ID of the subnet that the address belongs to. |
ExternalIpv6Address
Field | Description |
---|---|
address | string IPv6 address. |
AllocationPolicy
Field | Description |
---|---|
locations[] | Location Availability zones and subnets that the application load balancer resides. The minimum number of elements is 1. |
Location
Field | Description |
---|---|
zone_id | string Required. ID of the availability zone where the application load balancer resides. Each availability zone can only be specified once. |
subnet_id | string ID of the subnet that the application load balancer belongs to. |
disable_traffic | bool 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 LoadBalancingConfig.locality_aware_routing_percent and LoadBalancingConfig.strict_locality settings. |
AutoScalePolicy
Field | Description |
---|---|
min_zone_size | 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. |
max_size | 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 min_zone_size multiplied by the size of AllocationPolicy.locations. If the value is 0, there is no upper limit. Acceptable values are 0 to 1000, inclusive. |
LogOptions
Field | Description |
---|---|
log_group_id | 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. |
discard_rules[] | LogDiscardRule ordered list of rules, first matching rule applies |
disable | bool Do not send logs to Cloud Logging log group. |
LogDiscardRule
Field | Description |
---|---|
http_codes[] | int64 HTTP codes that should be discarded. Acceptable values are 100 to 599, inclusive. |
http_code_intervals[] | enum HttpCodeInterval Groups of HTTP codes like 4xx that should be discarded. |
grpc_codes[] | google.rpc.Code GRPC codes that should be discarded |
discard_percent | google.protobuf.Int64Value Percent of logs to be discarded: 0 - keep all, 100 or unset - discard all Acceptable values are 0 to 100, inclusive. |
AddSniMatch
Adds a SNI handler to the specified listener.
This request does not allow to add TlsListener.default_handler. Make an UpdateListener request instead.
rpc AddSniMatch (AddSniMatchRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:AddSniMatchMetadata
Operation.response:google.protobuf.Empty
AddSniMatchRequest
Field | Description |
---|---|
load_balancer_id | string Required. ID of the application load balancer to add a SNI handler to. |
listener_name | string Required. Name of the listener to add a SNI handler to. |
name | string Required. Name of the SNI handler to add. |
server_names[] | string Server names that are matched by the SNI handler. The number of elements must be greater than 0. |
handler | TlsHandler Required. Settings for handling requests with Server Name Indication (SNI) matching one of server_names values. |
TlsHandler
Field | Description |
---|---|
handler | oneof: http_handler or stream_handler Settings for handling requests. |
http_handler | HttpHandler HTTP handler. |
stream_handler | StreamHandler Stream (TCP) handler. |
certificate_ids[] | string 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. The number of elements must be greater than 0. |
HttpHandler
Field | Description |
---|---|
http_router_id | 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 HttpRouterService.List request. |
protocol_settings | oneof: http2_options or allow_http10 Protocol settings. For HTTPS (HTTP over TLS) connections, settings are applied to the protocol negotiated using TLS ALPN |
http2_options | Http2Options HTTP/2 settings. If specified, incoming HTTP/2 requests are supported by the listener. |
allow_http10 | bool Enables support for incoming HTTP/1.0 and HTTP/1.1 requests and disables it for HTTP/2 requests. |
rewrite_request_id | bool When unset, will preserve the incoming x-request-id header, otherwise would rewrite it with a new value. |
Http2Options
Field | Description |
---|---|
max_concurrent_streams | int64 Maximum number of concurrent HTTP/2 streams in a connection. |
StreamHandler
Field | Description |
---|---|
backend_group_id | 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 stream . To get the list of all available backend groups, make a BackendGroupService.List request. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
AddSniMatchMetadata
Field | Description |
---|---|
load_balancer_id | string ID of the application load balancer that the SNI handler is being added to. |
listener_name | string Name of the listener that the SNI handler is being added to. |
sni_match_name | string Name of the SNI handler that is being added to the listener. |
UpdateSniMatch
Updates the specified SNI handler of the specified listener.
This request does not allow to update TlsListener.default_handler. Make an UpdateListener request instead.
rpc UpdateSniMatch (UpdateSniMatchRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateSniMatchMetadata
Operation.response:google.protobuf.Empty
UpdateSniMatchRequest
Field | Description |
---|---|
load_balancer_id | string Required. ID of the application load balancer to update the SNI handler in. |
listener_name | string Required. Name of the listener to update the SNI handler in. |
name | string Required. Name of the SNI handler to update. |
update_mask | google.protobuf.FieldMask Field mask that specifies which attributes of the SNI handler should be updated. |
server_names[] | string New server names that are matched by the SNI handler. Existing set of server names is completely replaced by the provided set, so if you just want to add or remove a server name:
|
handler | TlsHandler Required. New settings for handling requests with Server Name Indication (SNI) matching one of server_names values. |
TlsHandler
Field | Description |
---|---|
handler | oneof: http_handler or stream_handler Settings for handling requests. |
http_handler | HttpHandler HTTP handler. |
stream_handler | StreamHandler Stream (TCP) handler. |
certificate_ids[] | string 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. The number of elements must be greater than 0. |
HttpHandler
Field | Description |
---|---|
http_router_id | 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 HttpRouterService.List request. |
protocol_settings | oneof: http2_options or allow_http10 Protocol settings. For HTTPS (HTTP over TLS) connections, settings are applied to the protocol negotiated using TLS ALPN |
http2_options | Http2Options HTTP/2 settings. If specified, incoming HTTP/2 requests are supported by the listener. |
allow_http10 | bool Enables support for incoming HTTP/1.0 and HTTP/1.1 requests and disables it for HTTP/2 requests. |
rewrite_request_id | bool When unset, will preserve the incoming x-request-id header, otherwise would rewrite it with a new value. |
Http2Options
Field | Description |
---|---|
max_concurrent_streams | int64 Maximum number of concurrent HTTP/2 streams in a connection. |
StreamHandler
Field | Description |
---|---|
backend_group_id | 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 stream . To get the list of all available backend groups, make a BackendGroupService.List request. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateSniMatchMetadata
Field | Description |
---|---|
load_balancer_id | string ID of the application load balancer that the SNI handler is being updated in. |
listener_name | string Name of the listener that the SNI handler is being updated in. |
sni_match_name | string Name of the SNI handler that is being updated. |
RemoveSniMatch
Deletes the specified SNI handler.
This request does not allow to delete TlsListener.default_handler.
rpc RemoveSniMatch (RemoveSniMatchRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:RemoveSniMatchMetadata
Operation.response:google.protobuf.Empty
RemoveSniMatchRequest
Field | Description |
---|---|
load_balancer_id | string Required. ID of the application load balancer to remove the SNI handler from. |
listener_name | string Required. Name of the listener te remove the SNI handler from. |
sni_match_name | string Required. Name of the SNI handler to remove. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
RemoveSniMatchMetadata
Field | Description |
---|---|
load_balancer_id | string ID of the application load balancer that the SNI handler is being removed from. |
listener_name | string Name of the listener that the SNI handler is being removed from. |
sni_match_name | string Name of the SNI handler that is being removed. |
GetTargetStates
Returns the statuses of all targets of the specified backend group in all their availability zones.
rpc GetTargetStates (GetTargetStatesRequest) returns (GetTargetStatesResponse)
GetTargetStatesRequest
Field | Description |
---|---|
load_balancer_id | string Required. ID of the application load balancer that the backend group is attributed to. |
backend_group_id | string Required. ID of the backend group that the target group is attributed to. |
target_group_id | string Required. ID of the target group to get target states of. |
GetTargetStatesResponse
Field | Description |
---|---|
target_states[] | TargetState Target states of the specified target group. |
TargetState
Field | Description |
---|---|
status | HealthcheckStatus Health of the target, i.e. its statuses in all availability zones. |
target | Target Required. Target. |
HealthcheckStatus
Field | Description |
---|---|
zone_statuses[] | ZoneHealthcheckStatus Statuses of the target in its availability zones. |
ZoneHealthcheckStatus
Field | Description |
---|---|
zone_id | string Required. ID of the availability zone. |
status | enum Status Status of the target in the availability zone.
|
failed_active_hc | bool Indicates whether the target has been marked UNHEALTHY due to failing active health checks, which determine target statuses as configured in HttpBackend.healthchecks or GrpcBackend.healthchecks. Currently the only type of health checks is active, as described above. Passive health checks, which determine the health of a target based on its responses to production requests (HTTP 5xx status codes, connection errors etc.), are not implemented yet. |
Target
Field | Description |
---|---|
address_type | oneof: ip_address Reference to the target. As of now, targets must only be referred to by their IP addresses. |
ip_address | string IP address of the target. |
subnet_id | string ID of the subnet that the target is connected to. |
private_ipv4_address | bool If set, will not require subnet_id to validate the target. Instead, the address should belong to one of the following ranges: 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16 Only one of subnet_id or private_ipv4_address should be set. |
ListOperations
Lists operations for the specified application load balancer.
rpc ListOperations (ListLoadBalancerOperationsRequest) returns (ListLoadBalancerOperationsResponse)
ListLoadBalancerOperationsRequest
Field | Description |
---|---|
load_balancer_id | string Required. ID of the application load balancer to get operations for. To get the application load balancer ID, use a LoadBalancerService.List request. The maximum string length in characters is 50. |
page_size | int64 The maximum number of results per page that should be returned. If the number of available results is larger than page_size , the service returns a ListLoadBalancerOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set page_token to the ListLoadBalancerOperationsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100. |
ListLoadBalancerOperationsResponse
Field | Description |
---|---|
operations[] | operation.Operation List of operations for the specified application load balancer. |
next_page_token | string Token for getting the next page of the list. If the number of results is greater than the specified ListLoadBalancerOperationsRequest.page_size, use next_page_token as the value for the ListLoadBalancerOperationsRequest.page_token parameter in the next list request. Each subsequent page will have its own next_page_token to continue paging through the results. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty |