Network Load Balancer API, gRPC: NetworkLoadBalancerService.AttachTargetGroup

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

Yandex Cloud

Обновлена 24 апреля 2025 г.

gRPC request
AttachNetworkLoadBalancerTargetGroupRequest
AttachedTargetGroup
HealthCheck
TcpOptions
HttpOptions
operation.Operation
AttachNetworkLoadBalancerTargetGroupMetadata
NetworkLoadBalancer
Listener
AttachedTargetGroup
HealthCheck
TcpOptions
HttpOptions

Attaches a target group to the specified network load balancer.

gRPC request

rpc AttachTargetGroup (AttachNetworkLoadBalancerTargetGroupRequest) returns (operation.Operation)

AttachNetworkLoadBalancerTargetGroupRequest

{
  "network_load_balancer_id": "string",
  "attached_target_group": {
    "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
      }
    ]
  }
}

Field

Description

network_load_balancer_id

string

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

attached_target_group

AttachedTargetGroup

Required field. ID of the attached target group to attach to the network load balancer.
To get the network load balancer ID, use a NetworkLoadBalancerService.List request.

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",
    "target_group_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",
    "allow_zonal_shift": "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	AttachNetworkLoadBalancerTargetGroupMetadata 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.

AttachNetworkLoadBalancerTargetGroupMetadata

Field

Description

network_load_balancer_id

string

ID of the network load balancer that the target group is being attached to.

target_group_id

string

ID of the target group.