Contact UsGet started
© 2024 Direct Cursus Technology L.L.C.

Application Load Balancer API, gRPC: TargetGroupService.AddTargets

Written by
Updated at December 17, 2024

Adds targets to the specified target group.

gRPC request

rpc AddTargets (AddTargetsRequest) returns (operation.Operation)

AddTargetsRequest

{
  "target_group_id": "string",
  "targets": [
    {
      // Includes only one of the fields `ip_address`
      "ip_address": "string",
      // end of the list of possible fields
      "subnet_id": "string",
      "private_ipv4_address": "bool"
    }
  ]
}

Field

Description

target_group_id

string

Required field. ID of the target group to add targets to.

To get the target group ID, make a TargetGroupService.List request.

targets[]

Target

List of targets to add to the target group.

Target

A target resource.
For details about the concept, see documentation.

Field

Description

ip_address

string

IP address of the target.

Includes only one of the fields ip_address.

Reference to the target. As of now, targets must only be referred to by their IP addresses.

subnet_id

string

ID of the subnet that the target is connected to.

private_ipv4_address

bool

If set, will not require subnet_id to validate the target.
Instead, the address should belong to one of the following ranges:
10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16
Only one of subnet_id or private_ipv4_address should be set.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "target_group_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "name": "string",
    "description": "string",
    "folder_id": "string",
    "labels": "map<string, string>",
    "targets": [
      {
        // Includes only one of the fields `ip_address`
        "ip_address": "string",
        // end of the list of possible fields
        "subnet_id": "string",
        "private_ipv4_address": "bool"
      }
    ],
    "created_at": "google.protobuf.Timestamp"
  }
  // 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

AddTargetsMetadata

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

TargetGroup

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.

AddTargetsMetadata

Field

Description

target_group_id

string

ID of the target group that the targets are being added to.

TargetGroup

A target group resource.
For details about the concept, see documentation.

Field

Description

id

string

ID of the target group. Generated at creation time.

name

string

Name of the target group. The name is unique within the folder.

description

string

Description of the target group.

folder_id

string

ID of the folder that the target group belongs to.

labels

object (map<string, string>)

Target group labels as key:value pairs.
For details about the concept, see documentation.

targets[]

Target

List of targets in the target group.

created_at

google.protobuf.Timestamp

Creation timestamp.

Target

A target resource.
For details about the concept, see documentation.

Field

Description

ip_address

string

IP address of the target.

Includes only one of the fields ip_address.

Reference to the target. As of now, targets must only be referred to by their IP addresses.

subnet_id

string

ID of the subnet that the target is connected to.

private_ipv4_address

bool

If set, will not require subnet_id to validate the target.
Instead, the address should belong to one of the following ranges:
10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16
Only one of subnet_id or private_ipv4_address should be set.
Previous
Delete
Next
RemoveTargets