Skip to main content

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.

import {
  cloudApi,
  serviceClients,
  Session,
  waitForOperation,
} from "@yandex-cloud/nodejs-sdk";

const UpdateSniMatchRequest =
  cloudApi.apploadbalancer.load_balancer_service.UpdateSniMatchRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.LoadBalancerServiceClient);

  const operation = await client.updateSniMatch(
    UpdateSniMatchRequest.fromPartial({
      loadBalancerId: "loadBalancerId",
      listenerName: "listenerName",
      name: "name",
      // updateMask: {
      // paths: ["paths"]
      // },
      // serverNames: ["serverNames"],
      handler: {
        // httpHandler: {
        // httpRouterId: "httpRouterId",
        // http2Options: {
        // maxConcurrentStreams: 0
        // },
        // allowHttp10: true,
        // rewriteRequestId: true
        // },
        // streamHandler: {
        // backendGroupId: "backendGroupId",
        // idleTimeout: {
        // seconds: 0,
        // nanos: 0
        // }
        // },
        // certificateIds: ["certificateIds"]
      },
    })
  );
  await waitForOperation(operation, session);
})();

UpdateSniMatchRequest​

loadBalancerId : string​

ID of the application load balancer to update the SNI handler in.

listenerName : string​

Name of the listener to update the SNI handler in.

name : string​

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:

  1. Get the current set of server names with a LoadBalancerService.Get request.
  2. Add or remove a server name in this set.
  3. Send the new set in this field.
handler : TlsHandler​

New settings for handling requests with Server Name Indication (SNI) matching one of server_names values.

TlsHandler​

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

One of handler​

Settings for handling requests.

  • httpHandler : HttpHandler​

    HTTP handler.

  • streamHandler : StreamHandler​

    Stream (TCP) handler.

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.

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.

One of protocolSettings​

Protocol settings.

For HTTPS (HTTP over TLS) connections, settings are applied to the protocol negotiated using TLS ALPN extension.

  • http2Options : Http2Options​

    HTTP/2 settings.

If specified, incoming HTTP/2 requests are supported by the listener.

  • allowHttp10 : bool​

    Enables support for incoming HTTP/1.0 and HTTP/1.1 requests and disables it for HTTP/2 requests.

rewriteRequestId : bool​

When unset, will preserve the incoming x-request-id header, otherwise would rewrite it with a new value.

StreamHandler​

A stream (TCP) handler resource.

backendGroupId : string​

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.

Http2Options​

An HTTP/2 options resource.

maxConcurrentStreams : int64​

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

Operation​

An Operation resource. For more information, see Operation.

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 : 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.

One of result​

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