Application Load Balancer API, gRPC: LoadBalancerService.UpdateSniMatch

Written by

Yandex Cloud

Updated at October 28, 2024

gRPC request
UpdateSniMatchRequest
TlsHandler
HttpHandler
Http2Options
StreamHandler
operation.Operation
UpdateSniMatchMetadata

Updates the specified SNI handler of the specified listener.

This request does not allow to update TlsListener.defaultHandler. Make an UpdateListener request instead.

gRPC request

rpc UpdateSniMatch (UpdateSniMatchRequest) returns (operation.Operation)

UpdateSniMatchRequest

{
  "loadBalancerId": "string",
  "listenerName": "string",
  "name": "string",
  "updateMask": "google.protobuf.FieldMask",
  "serverNames": [
    "string"
  ],
  "handler": {
    // Includes only one of the fields `httpHandler`, `streamHandler`
    "httpHandler": {
      "httpRouterId": "string",
      // Includes only one of the fields `http2Options`, `allowHttp10`
      "http2Options": {
        "maxConcurrentStreams": "int64"
      },
      "allowHttp10": "bool",
      // end of the list of possible fields
      "rewriteRequestId": "bool"
    },
    "streamHandler": {
      "backendGroupId": "string",
      "idleTimeout": "google.protobuf.Duration"
    },
    // end of the list of possible fields
    "certificateIds": [
      "string"
    ]
  }
}

Field	Description
loadBalancerId	string Required field. ID of the application load balancer to update the SNI handler in.
listenerName	string Required field. Name of the listener to update the SNI handler in.
name	string Required field. Name of the SNI handler to update.
updateMask	google.protobuf.FieldMask Field mask that specifies which attributes of the SNI handler should be updated.
serverNames[]	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: Get the current set of server names with a LoadBalancerService.Get request. Add or remove a server name in this set. Send the new set in this field.
handler	TlsHandler Required field. New settings for handling requests with Server Name Indication (SNI) matching one of `serverNames` values.

TlsHandler

A TLS-encrypted (HTTP or TCP stream) handler resource.

Field	Description
httpHandler	HttpHandler HTTP handler. Includes only one of the fields `httpHandler`, `streamHandler`. Settings for handling requests.
streamHandler	StreamHandler Stream (TCP) handler. Includes only one of the fields `httpHandler`, `streamHandler`. Settings for handling requests.
certificateIds[]	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.

HttpHandler

An HTTP handler resource.

Field	Description
httpRouterId	string ID of the HTTP router processing requests. For details about the concept, see documentation. To get the list of all available HTTP routers, make a HttpRouterService.List request.
http2Options	Http2Options HTTP/2 settings. If specified, incoming HTTP/2 requests are supported by the listener. Includes only one of the fields `http2Options`, `allowHttp10`. Protocol settings. For HTTPS (HTTP over TLS) connections, settings are applied to the protocol negotiated using TLS ALPN extension.
allowHttp10	bool Enables support for incoming HTTP/1.0 and HTTP/1.1 requests and disables it for HTTP/2 requests. Includes only one of the fields `http2Options`, `allowHttp10`. Protocol settings. For HTTPS (HTTP over TLS) connections, settings are applied to the protocol negotiated using TLS ALPN extension.
rewriteRequestId	bool When unset, will preserve the incoming x-request-id header, otherwise would rewrite it with a new value.

Http2Options

An HTTP/2 options resource.

Field

Description

maxConcurrentStreams

int64

Maximum number of concurrent HTTP/2 streams in a connection.

StreamHandler

A stream (TCP) handler resource.

Field

Description

backendGroupId

string

Required field. 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.

idleTimeout

google.protobuf.Duration

The idle timeout is duration during which no data is transmitted or received on either the upstream or downstream connection.
If not configured, the default idle timeout is 1 hour. Setting it to 0 disables the timeout.

operation.Operation

{
  "id": "string",
  "description": "string",
  "createdAt": "google.protobuf.Timestamp",
  "createdBy": "string",
  "modifiedAt": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "loadBalancerId": "string",
    "listenerName": "string",
    "sniMatchName": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Empty"
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
createdAt	google.protobuf.Timestamp Creation timestamp.
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	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	UpdateSniMatchMetadata 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `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.
response	google.protobuf.Empty 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. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `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.

UpdateSniMatchMetadata

Field	Description
loadBalancerId	string ID of the application load balancer that the SNI handler is being updated in.
listenerName	string Name of the listener that the SNI handler is being updated in.
sniMatchName	string Name of the SNI handler that is being updated.

Application Load Balancer API, gRPC: LoadBalancerService.UpdateSniMatch

gRPC requestgRPC request

UpdateSniMatchRequestUpdateSniMatchRequest

TlsHandlerTlsHandler

HttpHandlerHttpHandler

Http2OptionsHttp2Options

StreamHandlerStreamHandler

operation.Operationoperation.Operation

UpdateSniMatchMetadataUpdateSniMatchMetadata

Was the article helpful?