Skip to main content

List

Retrieves the list of Gateway resources in the specified folder.

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

const ListGatewaysRequest = cloudApi.vpc.gateway_service.ListGatewaysRequest;

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

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

ListGatewaysRequest​

folderId : string​

ID of the folder to list gateways 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 ListGatewaysResponse.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 ListGatewaysResponse.next_page_token returned by a previous list request.

filter : string​

A filter expression that filters Gateway listed in the response.

The expression must specify:

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

ListGatewaysResponse​

gateways : Gateway​

List of gateways.

nextPageToken : string​

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

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

Gateway​

A Gateway resource. For more information, see Gateway.

id : string​

ID of the gateway. Generated at creation time.

folderId : string​

ID of the folder that the gateway belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

name : string​

Name of the gateway. The name is unique within the folder. Value must match the regular expression \|[a-z]([-a-z0-9]{0,61}[a-z0-9])?.

description : string​

Description of the gateway. 0-256 characters long.

labels : string​

Gateway 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]*.

One of gateway​

Gateway specification

  • sharedEgressGateway : SharedEgressGateway​

SharedEgressGateway​

Shared Egress Gateway configuration