Virtual Private Cloud API, REST: Gateway.list
Retrieves the list of Gateway resources in the specified folder.
HTTP request
GET https://vpc.api.cloud.yandex.net/vpc/v1/gateways
Query parameters
Parameter | Description |
---|---|
folderId | Required. ID of the folder to list gateways in. To get the folder ID use a list request. The maximum string length in characters is 50. |
pageSize | The maximum number of results per page to return. If the number of available results is larger than The maximum value is 1000. |
pageToken | Page token. To get the next page of results, set The maximum string length in characters is 100. |
filter | A filter expression that filters Gateway listed in the response. The expression must specify:
The maximum string length in characters is 1000. |
Response
HTTP Code: 200 - OK
{
"gateways": [
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"sharedEgressGateway": {}
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
gateways[] | object List of gateways. |
gateways[]. id |
string ID of the gateway. Generated at creation time. |
gateways[]. folderId |
string ID of the folder that the gateway belongs to. |
gateways[]. createdAt |
string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
gateways[]. name |
string Name of the gateway. The name is unique within the folder. |
gateways[]. description |
string Description of the gateway. |
gateways[]. labels |
object Resource labels as |
gateways[]. sharedEgressGateway |
object Shared Egress Gateway configuration |
nextPageToken | string Token for getting the next page of the list. If the number of results is greater than the specified pageSize, use Each subsequent page will have its own |