Network Load Balancer API, gRPC: NetworkLoadBalancerService.Update

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

Yandex Cloud

Обновлена 17 декабря 2024 г.

gRPC request
UpdateNetworkLoadBalancerRequest
ListenerSpec
ExternalAddressSpec
InternalAddressSpec
AttachedTargetGroup
HealthCheck
TcpOptions
HttpOptions
operation.Operation
UpdateNetworkLoadBalancerMetadata
NetworkLoadBalancer
Listener
AttachedTargetGroup
HealthCheck
TcpOptions
HttpOptions

Updates the specified network load balancer.

gRPC request

rpc Update (UpdateNetworkLoadBalancerRequest) returns (operation.Operation)

UpdateNetworkLoadBalancerRequest

{
  "network_load_balancer_id": "string",
  "update_mask": "google.protobuf.FieldMask",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  "listener_specs": [
    {
      "name": "string",
      "port": "int64",
      "protocol": "Protocol",
      // Includes only one of the fields `external_address_spec`, `internal_address_spec`
      "external_address_spec": {
        "address": "string",
        "ip_version": "IpVersion"
      },
      "internal_address_spec": {
        "address": "string",
        "subnet_id": "string",
        "ip_version": "IpVersion"
      },
      // end of the list of possible fields
      "target_port": "int64"
    }
  ],
  "attached_target_groups": [
    {
      "target_group_id": "string",
      "health_checks": [
        {
          "name": "string",
          "interval": "google.protobuf.Duration",
          "timeout": "google.protobuf.Duration",
          "unhealthy_threshold": "int64",
          "healthy_threshold": "int64",
          // Includes only one of the fields `tcp_options`, `http_options`
          "tcp_options": {
            "port": "int64"
          },
          "http_options": {
            "port": "int64",
            "path": "string"
          }
          // end of the list of possible fields
        }
      ]
    }
  ],
  "deletion_protection": "bool"
}

Field	Description
network_load_balancer_id	string Required field. ID of the network load balancer to update. To get the network load balancer ID, use a NetworkLoadBalancerService.List request.
update_mask	google.protobuf.FieldMask Field mask that specifies which fields of the NetworkLoadBalancer resource are going to be updated.
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	object (map<string, string>) Resource labels as `key:value` pairs. The existing set of `labels` is completely replaced with the provided set.
listener_specs[]	ListenerSpec A list of listeners and their specs for the network load balancer.
attached_target_groups[]	AttachedTargetGroup A list of attached target groups for the network load balancer.
deletion_protection	bool 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	int64 Port for incoming traffic.
protocol	enum Protocol Required field. Protocol for incoming traffic. `PROTOCOL_UNSPECIFIED` `TCP` `UDP`
external_address_spec	ExternalAddressSpec External IP address specification. Includes only one of the fields `external_address_spec`, `internal_address_spec`. IP address for incoming traffic. Either the ID of the previously created address or the address specification.
internal_address_spec	InternalAddressSpec Internal IP address specification. Includes only one of the fields `external_address_spec`, `internal_address_spec`. IP address for incoming traffic. Either the ID of the previously created address or the address specification.
target_port	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.

ip_version

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.
subnet_id	string ID of the subnet.
ip_version	enum IpVersion IP version. `IP_VERSION_UNSPECIFIED` `IPV4`: IPv4 `IPV6`: IPv6

AttachedTargetGroup

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

Field

Description

target_group_id

string

Required field. ID of the target group.

health_checks[]

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	google.protobuf.Duration The interval between health checks. The default is 2 seconds.
timeout	google.protobuf.Duration Timeout for a target to return a response for the health check. The default is 1 second.
unhealthy_threshold	int64 Number of failed health checks before changing the status to `UNHEALTHY`. The default is 2.
healthy_threshold	int64 Number of successful health checks required in order to set the `HEALTHY` status for the target. The default is 2.
tcp_options	TcpOptions Options for TCP health check. Includes only one of the fields `tcp_options`, `http_options`. Protocol to use for the health check. Either TCP or HTTP.
http_options	HttpOptions Options for HTTP health check. Includes only one of the fields `tcp_options`, `http_options`. Protocol to use for the health check. Either TCP or HTTP.

TcpOptions

Configuration option for a TCP health check.

Field

Description

port

int64

Port to use for TCP health checks.

HttpOptions

Configuration option for an HTTP health check.

Field

Description

port

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

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "network_load_balancer_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "folder_id": "string",
    "created_at": "google.protobuf.Timestamp",
    "name": "string",
    "description": "string",
    "labels": "map<string, string>",
    "region_id": "string",
    "status": "Status",
    "type": "Type",
    "session_affinity": "SessionAffinity",
    "listeners": [
      {
        "name": "string",
        "address": "string",
        "port": "int64",
        "protocol": "Protocol",
        "target_port": "int64",
        "subnet_id": "string",
        "ip_version": "IpVersion"
      }
    ],
    "attached_target_groups": [
      {
        "target_group_id": "string",
        "health_checks": [
          {
            "name": "string",
            "interval": "google.protobuf.Duration",
            "timeout": "google.protobuf.Duration",
            "unhealthy_threshold": "int64",
            "healthy_threshold": "int64",
            // Includes only one of the fields `tcp_options`, `http_options`
            "tcp_options": {
              "port": "int64"
            },
            "http_options": {
              "port": "int64",
              "path": "string"
            }
            // end of the list of possible fields
          }
        ]
      }
    ],
    "deletion_protection": "bool"
  }
  // 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	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	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	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

network_load_balancer_id

string

ID of the NetworkLoadBalancer resource that is being updated.