Skip to main content

List

Retrieves the list of SecurityGroup resources in the specified folder.

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

const ListSecurityGroupsRequest =
  cloudApi.vpc.security_group_service.ListSecurityGroupsRequest;

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

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

ListSecurityGroupsRequest​

folderId : string​

ID of the folder to list security groups in. To get the folder ID, use 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 ListSecurityGroupsResponse.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 ListSecurityGroupsResponse.next_page_token returned by a previous list request.

filter : string​

A filter expression that filters resources listed in the response. The expression must specify:

  1. The field name. Currently you can use filtering only on the SecurityGroup.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].

ListSecurityGroupsResponse​

securityGroups : SecurityGroup​

List of SecurityGroup resources.

nextPageToken : string​

This token allows you to get the next page of results for list requests. If the number of results is larger than ListNetworksRequest.page_size, use the next_page_token as the value for the ListNetworksRequest.page_token query parameter in the next list request. Subsequent list requests will have their own next_page_token to continue paging through the results.

SecurityGroup​

Status​
  • STATUS_UNSPECIFIED

  • CREATING

    Security group is being created.

  • ACTIVE

    Security is active and it's rules are applied to the network interfaces.

  • UPDATING

    Security group is updating. Updating is a long operation because we must update all instances in SG.

  • DELETING

    Instance is being deleted.

id : string​

ID of the security group.

folderId : string​

ID of the folder that the security group belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp in RFC3339 text format.

name : string​

Name of the security group. The name must be unique within the folder. Value must match the regular expression \|[a-zA-Z]([-_a-zA-Z0-9]{0,61}[a-zA-Z0-9])?.

description : string​

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

labels : string​

Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\\@0-9a-z]*. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]*.

networkId : string​

ID of the network that the security group belongs to.

status : Status​

Security group status.

rules : SecurityGroupRule​

List of the security group rules.

defaultForNetwork : bool​

Flag that indicates that the security group is the default for the network.

SecurityGroupRule​

Direction​
  • DIRECTION_UNSPECIFIED

  • INGRESS

    Allows ingress traffic.

  • EGRESS

    Allows egress traffic.

id : string​

ID of the rule.

description : string​

Description of the rule. 0-256 characters long.

labels : string​

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

direction : Direction​

The direction of network traffic allowed by this rule.

ports : PortRange​

The range of ports that allow traffic to pass through. Null value means any.

protocolName : string​

Protocol name. Null value means any protocol. Values from IANA.

protocolNumber : int64​

Protocol number from IANA protocol numbers.

One of target​

  • cidrBlocks : CidrBlocks​

    CIDR blocks to allow to recieve or send traffic.

  • securityGroupId : string​

    ID of the security group to add rule to.

  • predefinedTarget : string​

    Predefined target. See security groups rules for more information.

PortRange​

fromPort : int64​

The lowest port in the range.

toPort : int64​

The highest port in the range.

CidrBlocks​

v4CidrBlocks : string​

IPv4 CIDR blocks to allow traffic to.

v6CidrBlocks : string​

IPv6 CIDR blocks to allow traffic to.