Method list
Retrieves the list of Network resources in the specified folder.
HTTP request
GET https://vpc.api.cloud.yandex.net/vpc/v1/networks
Query parameters
| Parameter | Description |
|---|---|
| folderId | Required. ID of the folder to list networks 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 pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Default value: 100. The maximum value is 1000. |
| pageToken | Page token. To get the next page of results, set pageToken to the nextPageToken returned by a previous list request. The maximum string length in characters is 100. |
| filter | 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 Network.name field. 2. An operator. Can be either = or != for single values, IN or NOT IN for lists of values. 3. The value. Must be 3-63 characters long and match the regular expression ^[a-z][-a-z0-9]{1,61}[a-z0-9]$. The maximum string length in characters is 1000. |
Response
HTTP Code: 200 - OK
{
"networks": [
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"defaultSecurityGroupId": "string"
}
],
"nextPageToken": "string"
}
| Field | Description |
|---|---|
| networks[] | object A Network resource. For more information, see Networks. |
| networks[]. id |
string ID of the network. |
| networks[]. folderId |
string ID of the folder that the network belongs to. |
| networks[]. createdAt |
string (date-time) Creation timestamp in RFC3339 text format. String in RFC3339 text format. |
| networks[]. name |
string Name of the network. The name is unique within the folder. 3-63 characters long. |
| networks[]. description |
string Optional description of the network. 0-256 characters long. |
| networks[]. labels |
object Resource labels as |
| networks[]. defaultSecurityGroupId |
string ID of default security group for network. |
| nextPageToken | string This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken query parameter in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. |