Подключиться
Yandex Network Load Balancer

Method addTargets

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

Adds targets to the target group.

HTTP request

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

Path parameters

Parameter Description
targetGroupId

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

The maximum string length in characters is 50.

Body parameters

{
  "targets": [
    {
      "subnetId": "string",
      "address": "string"
    }
  ]
}
Field Description
targets[] object

Required. List of targets to add to the target group.

The minimum number of elements is 1.
targets[].
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.

The maximum string length in characters is 50.
targets[].
address		 string

IP address of the target.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // 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.
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.
done boolean (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 object

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 object
The error result of the operation in case of failure or cancellation.
includes only one of the fields error, response
error.
code		 integer (int32)

Error code. An enum value of google.rpc.Code.
error.
message		 string

An error message.
error.
details[]		 object

A list of messages that carry the error details.
response object
includes only one of the fields error, response

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.
В этой статье: