Virtual Private Cloud API, REST: Subnet.list
Retrieves the list of Subnet resources in the specified folder.
HTTP request
GET https://vpc.api.cloud.yandex.net/vpc/v1/subnets
Query parameters
| Parameter | Description |
|---|---|
| folderId | Required. ID of the folder to list subnets 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:
The maximum string length in characters is 1000. |
Response
HTTP Code: 200 - OK
{
"subnets": [
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"networkId": "string",
"zoneId": "string",
"v4CidrBlocks": [
"string"
],
"v6CidrBlocks": [
"string"
],
"routeTableId": "string",
"dhcpOptions": {
"domainNameServers": [
"string"
],
"domainName": "string",
"ntpServers": [
"string"
]
}
}
],
"nextPageToken": "string"
}
| Field | Description |
|---|---|
| subnets[] | object List of Subnet resources. |
| subnets[]. id |
string ID of the subnet. |
| subnets[]. folderId |
string ID of the folder that the subnet belongs to. |
| subnets[]. createdAt |
string (date-time) Creation timestamp in RFC3339 text format. 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). |
| subnets[]. name |
string Name of the subnet. The name must be unique within the folder. Value must match the regular expression |
| subnets[]. description |
string Optional description of the subnet. 0-256 characters long. |
| subnets[]. labels |
object Resource labels, |
| subnets[]. networkId |
string ID of the network the subnet belongs to. |
| subnets[]. zoneId |
string ID of the availability zone where the subnet resides. |
| subnets[]. v4CidrBlocks[] |
string CIDR block. The range of internal addresses that are defined for this subnet. This field can be set only at Subnet resource creation time and cannot be changed. For example, 10.0.0.0/22 or 192.168.0.0/24. Minimum subnet size is /28, maximum subnet size is /16. |
| subnets[]. v6CidrBlocks[] |
string IPv6 not available yet. |
| subnets[]. routeTableId |
string ID of route table the subnet is linked to. |
| subnets[]. dhcpOptions |
object DHCP options for the subnet. |
| subnets[]. dhcpOptions. domainNameServers[] |
string A list of DHCP servers for this subnet. |
| subnets[]. dhcpOptions. domainName |
string A domain name to us as a suffix when resolving host names in this subnet. |
| subnets[]. dhcpOptions. ntpServers[] |
string List of NTP servers for this subnet. |
| 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. |