Virtual Private Cloud API, gRPC: GatewayService.List
Retrieves the list of Gateway resources in the specified folder.
gRPC request
rpc List (ListGatewaysRequest) returns (ListGatewaysResponse)
ListGatewaysRequest
{
"folderId": "string",
"pageSize": "int64",
"pageToken": "string",
"filter": "string"
}
Field |
Description |
folderId |
string Required field. 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 |
pageToken |
string Page token. To get the next page of results, set |
filter |
string A filter expression that filters Gateway listed in the response. The expression must specify:
|
ListGatewaysResponse
{
"gateways": [
{
"id": "string",
"folderId": "string",
"createdAt": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "string",
// Includes only one of the fields `sharedEgressGateway`
"sharedEgressGateway": "SharedEgressGateway"
// end of the list of possible fields
}
],
"nextPageToken": "string"
}
Field |
Description |
gateways[] |
List of gateways. |
nextPageToken |
string Token for getting the next page of the list. If the number of results is greater than Each subsequent page will have its own |
Gateway
A Gateway resource. For more information, see Gateway.
Field |
Description |
id |
string ID of the gateway. Generated at creation time. |
folderId |
string ID of the folder that the gateway belongs to. |
createdAt |
Creation timestamp. |
name |
string Name of the gateway. |
description |
string Description of the gateway. 0-256 characters long. |
labels |
string Gateway labels as |
sharedEgressGateway |
Includes only one of the fields Gateway specification |
SharedEgressGateway
Shared Egress Gateway configuration
Field |
Description |
Empty |