Network Load Balancer API, gRPC: NetworkLoadBalancerService.DetachTargetGroup

Written by

Yandex Cloud

Updated at December 17, 2024

gRPC request
DetachNetworkLoadBalancerTargetGroupRequest
operation.Operation
DetachNetworkLoadBalancerTargetGroupMetadata
NetworkLoadBalancer
Listener
AttachedTargetGroup
HealthCheck
TcpOptions
HttpOptions

Detaches the target group from the specified network load balancer.

gRPC request

rpc DetachTargetGroup (DetachNetworkLoadBalancerTargetGroupRequest) returns (operation.Operation)

DetachNetworkLoadBalancerTargetGroupRequest

{
  "network_load_balancer_id": "string",
  "target_group_id": "string"
}

Field

Description

network_load_balancer_id

string

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

target_group_id

string

Required field. ID of the target group.

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"
  }
  // 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	DetachNetworkLoadBalancerTargetGroupMetadata 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.

DetachNetworkLoadBalancerTargetGroupMetadata

Field

Description

network_load_balancer_id

string

ID of the network load balancer that the target group is being detached from.

target_group_id

string

ID of the target group.

NetworkLoadBalancer

A NetworkLoadBalancer resource. For more information, see Network Load Balancer.

Field	Description
id	string ID of the network load balancer.
folder_id	string ID of the folder that the network load balancer belongs to.
created_at	google.protobuf.Timestamp Creation timestamp in RFC3339 text format.
name	string Name of the network load balancer. The name is unique within the folder. 3-63 characters long.
description	string Optional description of the network load balancer. 0-256 characters long.
labels	object (map<string, string>) Resource labels as `key:value` pairs. Maximum of 64 per resource.
region_id	string ID of the region that the network load balancer belongs to.
status	enum Status Status of the network load balancer. `STATUS_UNSPECIFIED` `CREATING`: Network load balancer is being created. `STARTING`: Network load balancer is being started. `ACTIVE`: Network load balancer is active and sends traffic to the targets. `STOPPING`: Network load balancer is being stopped. `STOPPED`: Network load balancer is stopped and doesn't send traffic to the targets. `DELETING`: Network load balancer is being deleted. `INACTIVE`: The load balancer doesn't have any listeners or target groups, or attached target groups are empty. The load balancer doesn't perform any health checks or send traffic in this state.
type	enum Type Type of the network load balancer. Only external network load balancers are available now. `TYPE_UNSPECIFIED` `EXTERNAL`: External network load balancer. `INTERNAL`: Internal network load balancer.
session_affinity	enum SessionAffinity Type of the session affinity. Only 5-tuple affinity is available now. `SESSION_AFFINITY_UNSPECIFIED` `CLIENT_IP_PORT_PROTO`: 5-tuple affinity.
listeners[]	Listener List of listeners for the network load balancer.
attached_target_groups[]	AttachedTargetGroup List of target groups attached to the network load balancer.
deletion_protection	bool Specifies if network load balancer protected from deletion.

Listener

A Listener resource. For more information, see Listener

Field	Description
name	string Name of the listener. The name must be unique for each listener on a single load balancer. 3-63 characters long.
address	string IP address for the listener.
port	int64 Port.
protocol	enum Protocol Network protocol for incoming traffic. `PROTOCOL_UNSPECIFIED` `TCP` `UDP`
target_port	int64 Port of a target.
subnet_id	string ID of the subnet.
ip_version	enum IpVersion IP version of the external address. `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 /.

Network Load Balancer API, gRPC: NetworkLoadBalancerService.DetachTargetGroup

gRPC requestgRPC request

DetachNetworkLoadBalancerTargetGroupRequestDetachNetworkLoadBalancerTargetGroupRequest

operation.Operationoperation.Operation

DetachNetworkLoadBalancerTargetGroupMetadataDetachNetworkLoadBalancerTargetGroupMetadata

NetworkLoadBalancerNetworkLoadBalancer

ListenerListener

AttachedTargetGroupAttachedTargetGroup

HealthCheckHealthCheck

TcpOptionsTcpOptions

HttpOptionsHttpOptions

Was the article helpful?

gRPC request

DetachNetworkLoadBalancerTargetGroupRequest

operation.Operation

DetachNetworkLoadBalancerTargetGroupMetadata

NetworkLoadBalancer

Listener

AttachedTargetGroup

HealthCheck

TcpOptions

HttpOptions