Skip to main content

Create

Creates a target group in the specified folder and adds the specified targets to it.

import {
cloudApi,
decodeMessage,
serviceClients,
Session,
waitForOperation,
} from "@yandex-cloud/nodejs-sdk";

const CreateTargetGroupRequest =
cloudApi.apploadbalancer.target_group_service.CreateTargetGroupRequest;
const TargetGroup = cloudApi.apploadbalancer.target_group.TargetGroup;

(async () => {
const authToken = process.env["YC_OAUTH_TOKEN"];
const session = new Session({ oauthToken: authToken });
const client = session.client(serviceClients.TargetGroupServiceClient);

const operation = await client.create(
CreateTargetGroupRequest.fromPartial({
folderId: "folderId",
// name: "name",
// description: "description",
// labels: {"key": "labels"},
// targets: [{
// ipAddress: "ipAddress",
// subnetId: "subnetId",
// privateIpv4Address: true
// }]
})
);
const finishedOp = await waitForOperation(operation, session);

if (finishedOp.response) {
const result = decodeMessage<typeof TargetGroup>(finishedOp.response);
console.log(result);
}
})();

CreateTargetGroupRequest

folderId : string

ID of the folder to list target groups in. To get the folder ID, use a TargetGroupService.List request.

name : string

Name of the target group. The name must be unique within the folder.

description : string

Description of the target group.

labels : string

Resource labels as key:value pairs.

regionId : string

ID of the availability zone where the target group resides.

targets : Target

List of targets within the target group.

Target

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

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.

Operation

An Operation resource. For more information, see Operation.

id : string

ID of the operation.

description : string

Description of the operation. 0-256 characters long.

createdAt : google.protobuf.Timestamp

Creation timestamp.

createdBy : string

ID of the user or service account who initiated the operation.

modifiedAt : 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 : google.protobuf.Any

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.

One of result

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.

  • error : google.rpc.Status

    The error result of the operation in case of failure or cancellation.

  • response : google.protobuf.Any
    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.