Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Network Load Balancer API, REST: TargetGroup.AddTargets

Written by
Updated at October 17, 2024

Adds targets to the target group.

HTTP request

POST https://load-balancer.api.cloud.yandex.net/load-balancer/v1/targetGroups/{targetGroupId}:addTargets

Path parameters

Field

Description

targetGroupId

string

Required field. ID of the TargetGroup resource to add targets to.
To get the target group ID, use a TargetGroupService.List request.

Body parameters

{
  "targets": [
    {
      "subnetId": "string",
      "address": "string"
    }
  ]
}

Field

Description

targets[]

Target

List of targets to add to the target group.

Target

A Target resource. For more information, see Target groups and resources.

Field

Description

subnetId

string

ID of the subnet that targets are connected to.
All targets in the target group must be connected to the same subnet within a single availability zone.

address

string

IP address of the target.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "targetGroupId": "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",
    "targets": [
      {
        "subnetId": "string",
        "address": "string"
      }
    ]
  }
  // 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

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

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

targetGroupId

string

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

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.

TargetGroup

A TargetGroup resource. For more information, see Target groups and resources.

Field

Description

id

string

Output only. ID of the target group.

folderId

string

ID of the folder that the target group belongs to.

createdAt

string (date-time)

Output only. Creation timestamp in RFC3339 text format.

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

name

string

Name of the target group.
The name is unique within the folder. 3-63 characters long.

description

string

Description of the target group. 0-256 characters long.

labels

string

Resource labels as key:value pairs. Maximum of 64 per resource.

regionId

string

ID of the region where the target group resides.

targets[]

Target

A list of targets in the target group.

Target

A Target resource. For more information, see Target groups and resources.

Field

Description

subnetId

string

ID of the subnet that targets are connected to.
All targets in the target group must be connected to the same subnet within a single availability zone.

address

string

IP address of the target.
Previous
Delete
Next
RemoveTargets