Smart Web Security Load Balancer API, gRPC: DomainService.Update

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

Yandex Cloud

Обновлена 21 сентября 2026 г.

Открыть в Markdown

gRPC request
UpdateDomainRequest
HttpBackend
Target
SessionAffinity
ConnectionSessionAffinity
HeaderSessionAffinity
CookieSessionAffinity
TlsListener
HttpListener
SolidWafSettings
RateLimit
operation.Operation

Updates the specified domain.

gRPC request

rpc Update (UpdateDomainRequest) returns (operation.Operation)

UpdateDomainRequest

{
  "load_balancer_id": "string",
  "name": "string",
  "update_mask": "google.protobuf.FieldMask",
  "server_name": "string",
  "description": "string",
  "security_profile_id": "string",
  "http_backend": {
    "targets": [
      {
        "ip_address": "string",
        "description": "string",
        "port": "int64"
      }
    ],
    "use_http2": "bool",
    "use_tls": "bool",
    "sni": "string",
    "trusted_ca_bytes": "string",
    "timeout": "google.protobuf.Duration",
    "idle_timeout": "google.protobuf.Duration",
    "session_affinity": {
      // Includes only one of the fields `connection`, `header`, `cookie`
      "connection": {
        "source_ip": "bool"
      },
      "header": {
        "header_name": "string"
      },
      "cookie": {
        "name": "string",
        "ttl": "google.protobuf.Duration",
        "path": "string"
      }
      // end of the list of possible fields
    }
  },
  "tls_listener": {
    "enabled": "bool",
    "certificate_id": "string",
    "port": "int64",
    "enable_http1": "bool"
  },
  "http_listener": {
    "enabled": "bool",
    "redirect_to_https": "bool",
    "port": "int64"
  },
  "solid_waf_settings": {
    "solid_waf_profile_id": "string",
    "session_affinity": {
      // Includes only one of the fields `connection`, `header`, `cookie`
      "connection": {
        "source_ip": "bool"
      },
      "header": {
        "header_name": "string"
      },
      "cookie": {
        "name": "string",
        "ttl": "google.protobuf.Duration",
        "path": "string"
      }
      // end of the list of possible fields
    },
    "web_app_id": "string"
  },
  "rate_limit": {
    "all_requests_per_second": "int64",
    "requests_per_ip_per_second": "int64"
  }
}

Field	Description
load_balancer_id	string Required field. ID of the Load balancer that the domain belongs to.
name	string Required field. Name of domain that is being updated.
update_mask	google.protobuf.FieldMask List of fields to update.
server_name	string Required field. Server name or wildcard to be matched against SNI in a TLS connection and authority(host) header. Wildcards are in the form of ".s.o.m.e". Allowed: "example.com", ".example.com". Not allowed: "..example.com", "*-sub.example.com". The string length in characters must be 1-255.
description	string Domain description The maximum string length in characters is 512.
security_profile_id	string Security Profile ID of SmartWebSecurity service.
http_backend	HttpBackend Backend settings.
tls_listener	TlsListener Optional TLS listener settings.
http_listener	HttpListener Optional plaintext listener settings.
solid_waf_settings	SolidWafSettings Optional Solid WAF settings.
rate_limit	RateLimit Optional rate limit settings.

HttpBackend

Field	Description
targets[]	Target List of targets. The number of elements must be in the range 1-20.
use_http2	bool Enables HTTP2 for upstream requests. If not set, HTTP 1.1 will be used by default.
use_tls	bool Enable TLS for upstream requests.
sni	string SNI string for TLS connections. Applicable only if use_tls enabled. The maximum string length in characters is 255. Value must match the regular expression `[-.a-z0-9]*`.
trusted_ca_bytes	string Trusted certificate authority certificates bundle (PEM text). Applicable only if use_tls enabled.
timeout	google.protobuf.Duration Backend timeout. If not set, default is 300 seconds.
idle_timeout	google.protobuf.Duration Specifies the idle timeout for the route. If not specified, there is no per-route idle timeout.
session_affinity	SessionAffinity Session affinity.

Target

Field	Description
ip_address	string IPv4 address. The string length in characters must be 1-40.
description	string Target description. The maximum string length in characters is 128.
port	int64 Target port. Acceptable values are 1 to 65535, inclusive.

SessionAffinity

Field	Description
connection	ConnectionSessionAffinity Session affinity based on source IP address. Includes only one of the fields `connection`, `header`, `cookie`.
header	HeaderSessionAffinity Session affinity based on an HTTP header. Includes only one of the fields `connection`, `header`, `cookie`.
cookie	CookieSessionAffinity Session affinity based on a cookie. Includes only one of the fields `connection`, `header`, `cookie`.

ConnectionSessionAffinity

Field

Description

source_ip

bool

IP address.

HeaderSessionAffinity

Field

Description

header_name

string

Header name.

The string length in characters must be 1-256.

CookieSessionAffinity

Field	Description
name	string Cookie name. The string length in characters must be 1-256.
ttl	google.protobuf.Duration If not set, session cookie will be used (not persisted between browser restarts).
path	string Optional cookie path. The string length in characters must be 0-256.

TlsListener

Field	Description
enabled	bool Enable TLS listener.
certificate_id	string Certificate ID in the Certificate Manager.
port	int64 Listener port. If value is not set, used 443 by default. Acceptable values are 0 to 65535, inclusive.
enable_http1	bool Enables HTTP/1.0 and HTTP/1.1 support and disables HTTP/2.

HttpListener

Field	Description
enabled	bool Enable http (plaintext) listener.
redirect_to_https	bool Automatically redirect from HTTP to HTTPS. If TlsListener's port is 443 or not set, redirect URL will be "https://<host><path>" and "https://<host>:<port><path>" in other case.
port	int64 Listener port. If value is not set, used 80 by default. Acceptable values are 0 to 65535, inclusive.

SolidWafSettings

Field	Description
solid_waf_profile_id	string ID of the Solid WAF profile.
session_affinity	SessionAffinity Session affinity to analyzers. If not set, ConnectionSessionAffinity will be used.
web_app_id	string ID of the Solid WAF web app.

RateLimit

Field

Description

all_requests_per_second

int64

Rate limit for all requests.
Defaults:

with SolidWaf enabled: 20000 RPS
without SolidWaf enabled: unlimited

The minimum value is 0.

requests_per_ip_per_second

int64

Rate limit for individual IP addresses.
Defaults:

with SolidWaf enabled: 1000 RPS
without SolidWaf enabled: unlimited

The minimum value is 0.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": "google.protobuf.Any",
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Any"
  // 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.
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.
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.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. 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.

Smart Web Security Load Balancer API, gRPC: DomainService.Update

gRPC requestgRPC request

UpdateDomainRequestUpdateDomainRequest

HttpBackendHttpBackend

TargetTarget

SessionAffinitySessionAffinity

ConnectionSessionAffinityConnectionSessionAffinity

HeaderSessionAffinityHeaderSessionAffinity

CookieSessionAffinityCookieSessionAffinity

TlsListenerTlsListener

HttpListenerHttpListener

SolidWafSettingsSolidWafSettings

RateLimitRateLimit

operation.Operationoperation.Operation

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

gRPC request

UpdateDomainRequest

HttpBackend

Target

SessionAffinity

ConnectionSessionAffinity

HeaderSessionAffinity

CookieSessionAffinity

TlsListener

HttpListener

SolidWafSettings

RateLimit

operation.Operation