Skip to main content

List

Lists target groups in the specified folder.

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

const ListTargetGroupsRequest =
  cloudApi.apploadbalancer.target_group_service.ListTargetGroupsRequest;

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

  const result = await client.list(
    ListTargetGroupsRequest.fromPartial({
      folderId: "folderId",
      // pageSize: 0,
      // pageToken: "pageToken",
      // filter: "filter"
    })
  );
  console.log(result);
})();

ListTargetGroupsRequest​

folderId : string​

ID of the folder to list target groups in.

To get the folder ID, make a yandex.cloud.resourcemanager.v1.FolderService.List request.

pageSize : int64​

The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListTargetGroupsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100.

pageToken : string​

Page token. To get the next page of results, set page_token to the ListTargetGroupsResponse.next_page_token returned by a previous list request.

filter : string​

A filter expression that filters target groups listed in the response.

The expression must specify:

  1. The field name. Currently you can use filtering only on TargetGroup.name field.
  2. An = operator.
  3. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9]. Example of a filter: name=my-target-group.

ListTargetGroupsResponse​

targetGroups : TargetGroup​

List of target groups in the specified folder.

nextPageToken : string​

Token for getting the next page of the list. If the number of results is greater than the specified ListTargetGroupsRequest.page_size, use next_page_token as the value for the ListTargetGroupsRequest.page_token parameter in the next list request.

Each subsequent page will have its own next_page_token to continue paging through the results.

TargetGroup​

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

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.

folderId : string​

ID of the folder that the target group belongs to.

labels : string​

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

targets : Target​

List of targets in the target group.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

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.