Network Load Balancer API, REST: NetworkLoadBalancer.Update

Written by

Updated at October 17, 2024

HTTP request
Path parameters
Body parameters
ListenerSpec
ExternalAddressSpec
InternalAddressSpec
AttachedTargetGroup
HealthCheck
TcpOptions
HttpOptions
Response
UpdateNetworkLoadBalancerMetadata
Status
NetworkLoadBalancer
Listener
AttachedTargetGroup
HealthCheck
TcpOptions
HttpOptions

Updates the specified network load balancer.

HTTP request

PATCH https://load-balancer.api.cloud.yandex.net/load-balancer/v1/networkLoadBalancers/{networkLoadBalancerId}

Path parameters

Field

Description

networkLoadBalancerId

string

Required field. ID of the network load balancer to update.
To get the network load balancer ID, use a NetworkLoadBalancerService.List request.

Body parameters

{
  "updateMask": "string",
  "name": "string",
  "description": "string",
  "labels": "string",
  "listenerSpecs": [
    {
      "name": "string",
      "port": "string",
      "protocol": "string",
      // Includes only one of the fields `externalAddressSpec`, `internalAddressSpec`
      "externalAddressSpec": {
        "address": "string",
        "ipVersion": "string"
      },
      "internalAddressSpec": {
        "address": "string",
        "subnetId": "string",
        "ipVersion": "string"
      },
      // end of the list of possible fields
      "targetPort": "string"
    }
  ],
  "attachedTargetGroups": [
    {
      "targetGroupId": "string",
      "healthChecks": [
        {
          "name": "string",
          "interval": "string",
          "timeout": "string",
          "unhealthyThreshold": "string",
          "healthyThreshold": "string",
          // Includes only one of the fields `tcpOptions`, `httpOptions`
          "tcpOptions": {
            "port": "string"
          },
          "httpOptions": {
            "port": "string",
            "path": "string"
          }
          // end of the list of possible fields
        }
      ]
    }
  ],
  "deletionProtection": "boolean"
}

Field	Description
updateMask	string (field-mask) A comma-separated names off ALL fields to be updated. Only the specified fields will be changed. The others will be left untouched. If the field is specified in `updateMask` and no value for that field was sent in the request, the field's value will be reset to the default. The default value for most fields is null or 0. If `updateMask` is not sent in the request, all fields' values will be updated. Fields specified in the request will be updated to provided values. The rest of the fields will be reset to the default.
name	string Name of the network load balancer. The name must be unique within the folder.
description	string Description of the network load balancer.
labels	string Resource labels as `key:value` pairs. The existing set of `labels` is completely replaced with the provided set.
listenerSpecs[]	ListenerSpec A list of listeners and their specs for the network load balancer.
attachedTargetGroups[]	AttachedTargetGroup A list of attached target groups for the network load balancer.
deletionProtection	boolean Specifies if network load balancer protected from deletion.

ListenerSpec

Listener specification that will be used by a network load balancer.

Field	Description
name	string Required field. Name of the listener. The name must be unique for each listener on a single load balancer. 3-63 characters long.
port	string (int64) Port for incoming traffic.
protocol	enum (Protocol) Required field. Protocol for incoming traffic. `PROTOCOL_UNSPECIFIED` `TCP` `UDP`
externalAddressSpec	ExternalAddressSpec External IP address specification. Includes only one of the fields `externalAddressSpec`, `internalAddressSpec`. IP address for incoming traffic. Either the ID of the previously created address or the address specification.
internalAddressSpec	InternalAddressSpec Internal IP address specification. Includes only one of the fields `externalAddressSpec`, `internalAddressSpec`. IP address for incoming traffic. Either the ID of the previously created address or the address specification.
targetPort	string (int64) Port of a target. Acceptable values are 1 to 65535, inclusive.

ExternalAddressSpec

External address specification that is used by ListenerSpec.

Field

Description

address

string

Public IP address for a listener.
If you provide a static public IP address for the NetworkLoadBalancerService.Update
method, it will replace the existing listener address.

ipVersion

enum (IpVersion)

IP version.

IP_VERSION_UNSPECIFIED
IPV4: IPv4
IPV6: IPv6

InternalAddressSpec

Internal address specification that is used by ListenerSpec.

Field	Description
address	string Internal IP address for a listener.
subnetId	string ID of the subnet.
ipVersion	enum (IpVersion) IP version. `IP_VERSION_UNSPECIFIED` `IPV4`: IPv4 `IPV6`: IPv6

AttachedTargetGroup

An AttachedTargetGroup resource. For more information, see Targets and groups.

Field

Description

targetGroupId

string

Required field. ID of the target group.

healthChecks[]

HealthCheck

A health check to perform on the target group.
For now we accept only one health check per AttachedTargetGroup.

HealthCheck

A HealthCheck resource. For more information, see Health check.

Field	Description
name	string Required field. Name of the health check. The name must be unique for each target group that attached to a single load balancer. 3-63 characters long.
interval	string (duration) The interval between health checks. The default is 2 seconds.
timeout	string (duration) Timeout for a target to return a response for the health check. The default is 1 second.
unhealthyThreshold	string (int64) Number of failed health checks before changing the status to `UNHEALTHY`. The default is 2.
healthyThreshold	string (int64) Number of successful health checks required in order to set the `HEALTHY` status for the target. The default is 2.
tcpOptions	TcpOptions Options for TCP health check. Includes only one of the fields `tcpOptions`, `httpOptions`. Protocol to use for the health check. Either TCP or HTTP.
httpOptions	HttpOptions Options for HTTP health check. Includes only one of the fields `tcpOptions`, `httpOptions`. Protocol to use for the health check. Either TCP or HTTP.

TcpOptions

Configuration option for a TCP health check.

Field

Description

port

string (int64)

Port to use for TCP health checks.

HttpOptions

Configuration option for an HTTP health check.

Field

Description

port

string (int64)

Port to use for HTTP health checks.

path

string

URL path to set for health checking requests for every target in the target group.
For example /ping. The default path is /.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "networkLoadBalancerId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "folderId": "string",
    "createdAt": "string",
    "name": "string",
    "description": "string",
    "labels": "string",
    "regionId": "string",
    "status": "string",
    "type": "string",
    "sessionAffinity": "string",
    "listeners": [
      {
        "name": "string",
        "address": "string",
        "port": "string",
        "protocol": "string",
        "targetPort": "string",
        "subnetId": "string",
        "ipVersion": "string"
      }
    ],
    "attachedTargetGroups": [
      {
        "targetGroupId": "string",
        "healthChecks": [
          {
            "name": "string",
            "interval": "string",
            "timeout": "string",
            "unhealthyThreshold": "string",
            "healthyThreshold": "string",
            // Includes only one of the fields `tcpOptions`, `httpOptions`
            "tcpOptions": {
              "port": "string"
            },
            "httpOptions": {
              "port": "string",
              "path": "string"
            }
            // end of the list of possible fields
          }
        ]
      }
    ],
    "deletionProtection": "boolean"
  }
  // 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. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
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. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
done	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	UpdateNetworkLoadBalancerMetadata 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	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	NetworkLoadBalancer 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.

UpdateNetworkLoadBalancerMetadata

Field

Description

networkLoadBalancerId

string

ID of the NetworkLoadBalancer resource that is being updated.

Status

The error result of the operation in case of failure or cancellation.

Field	Description
code	integer (int32) Error code. An enum value of google.rpc.Code.
message	string An error message.
details[]	object A list of messages that carry the error details.