Skip to main content

Update

Updates the specified target group.

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

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

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

  const operation = await client.update(
    UpdateTargetGroupRequest.fromPartial({
      targetGroupId: "targetGroupId",
      // updateMask: {
      // paths: ["paths"]
      // },
      // 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);
  }
})();

UpdateTargetGroupRequest​

targetGroupId : string​

ID of the target group to update.

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

updateMask : google.protobuf.FieldMask​

Field mask that specifies which attributes of the target group should be updated.

name : string​

New name for the target group. The name must be unique within the folder.

description : string​

New description of the target group.

labels : string​

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

Existing set of labels is completely replaced by the provided set, so if you just want to add or remove a label:

  1. Get the current set of labels with a TargetGroupService.Get request.
  2. Add or remove a label in this set.
  3. Send the new set in this field.
targets : Target​

New list of targets in the target group.

Existing list of targets is completely replaced by the specified list, so if you just want to add or remove a target, make a TargetGroupService.AddTargets request or a TargetGroupService.RemoveTargets request.

Target​

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

One of addressType​

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

  • ipAddress : string​

    IP address of the target.

subnetId : string​

ID of the subnet that the target is connected to.

privateIpv4Address : 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​

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.