Method addSniMatch

Статья создана

HTTP request
Path parameters
Body parameters
Response

Adds a SNI handler to the specified listener.

This request does not allow to add defaultHandler. Make an updateListener request instead.

HTTP request

POST https://alb.api.cloud.yandex.net/apploadbalancer/v1/loadBalancers/{loadBalancerId}:addSniMatch

Path parameters

Parameter	Description
loadBalancerId	Required. ID of the application load balancer to add a SNI handler to.

Body parameters

{
  "listenerName": "string",
  "name": "string",
  "serverNames": [
    "string"
  ],
  "handler": {
    "certificateIds": [
      "string"
    ],

    // `handler` includes only one of the fields `httpHandler`, `streamHandler`
    "httpHandler": {
      "httpRouterId": "string",

      // `handler.httpHandler` includes only one of the fields `http2Options`, `allowHttp10`
      "http2Options": {
        "maxConcurrentStreams": "string"
      },
      "allowHttp10": true,
      // end of the list of possible fields`handler.httpHandler`

    },
    "streamHandler": {
      "backendGroupId": "string"
    },
    // end of the list of possible fields`handler`

  }
}

Field	Description
listenerName	string Required. Name of the listener to add a SNI handler to.
name	string Required. Name of the SNI handler to add.
serverNames[]	string Required. Server names that are matched by the SNI handler. Must contain at least one element.
handler	object Required. Settings for handling requests with Server Name Indication (SNI) matching one of serverNames values. A TLS-encrypted (HTTP or TCP stream) handler resource.
handler. certificateIds[]	string Required. ID's of the TLS server certificates from Certificate Manager. RSA and ECDSA certificates are supported, and only the first certificate of each type is used. Must contain at least one element.
handler. httpHandler	object HTTP handler. `handler` includes only one of the fields `httpHandler`, `streamHandler` An HTTP handler resource.
handler. httpHandler. httpRouterId	string ID of the HTTP router processing requests. For details about the concept, see documentation. To get the list of all available HTTP routers, make a list request.
handler. httpHandler. http2Options	object HTTP/2 settings. If specified, incoming HTTP/2 requests are supported by the listener. `handler.httpHandler` includes only one of the fields `http2Options`, `allowHttp10` An HTTP/2 options resource.
handler. httpHandler. http2Options. maxConcurrentStreams	string (int64) Maximum number of concurrent HTTP/2 streams in a connection.
handler. httpHandler. allowHttp10	boolean (boolean) `handler.httpHandler` includes only one of the fields `http2Options`, `allowHttp10` Enables support for incoming HTTP/1.0 and HTTP/1.1 requests and disables it for HTTP/2 requests.
handler. streamHandler	object Stream (TCP) handler. `handler` includes only one of the fields `httpHandler`, `streamHandler` A stream (TCP) handler resource.
handler. streamHandler. backendGroupId	string Required. ID of the backend group processing requests. For details about the concept, see documentation. The backend group type, specified via [BackendGroup.backend], must be `stream`. To get the list of all available backend groups, make a list request.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // 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	string (date-time) Creation timestamp. String in RFC3339 text format.
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	string (date-time) The time when the Operation resource was last modified. String in RFC3339 text format.
done	boolean (boolean) 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	object 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	object The error result of the operation in case of failure or cancellation. includes only one of the fields `error`, `response` The error result of the operation in case of failure or cancellation.
error. code	integer (int32) Error code. An enum value of google.rpc.Code.
error. message	string An error message.
error. details[]	object A list of messages that carry the error details.
response	object includes only one of the fields `error`, `response` 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.

Method addSniMatch

HTTP request

Path parameters

Body parameters

Response

Была ли статья полезна?