Virtual Private Cloud API, gRPC: SubnetService.List
Retrieves the list of Subnet resources in the specified folder.
gRPC request
rpc List (ListSubnetsRequest) returns (ListSubnetsResponse)
ListSubnetsRequest
{
"folderId": "string",
"pageSize": "int64",
"pageToken": "string",
"filter": "string"
}
Field |
Description |
folderId |
string Required field. ID of the folder to list subnets in. |
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 resources listed in the response.
|
ListSubnetsResponse
{
"subnets": [
{
"id": "string",
"folderId": "string",
"createdAt": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "string",
"networkId": "string",
"zoneId": "string",
"v4CidrBlocks": [
"string"
],
"v6CidrBlocks": [
"string"
],
"routeTableId": "string",
"dhcpOptions": {
"domainNameServers": [
"string"
],
"domainName": "string",
"ntpServers": [
"string"
]
}
}
],
"nextPageToken": "string"
}
Field |
Description |
subnets[] |
List of Subnet resources. |
nextPageToken |
string This token allows you to get the next page of results for list requests. If the number of results |
Subnet
A Subnet resource. For more information, see Subnets.
Field |
Description |
id |
string ID of the subnet. |
folderId |
string ID of the folder that the subnet belongs to. |
createdAt |
Creation timestamp in RFC3339 |
name |
string Name of the subnet. |
description |
string Optional description of the subnet. 0-256 characters long. |
labels |
string Resource labels, |
networkId |
string ID of the network the subnet belongs to. |
zoneId |
string ID of the availability zone where the subnet resides. |
v4CidrBlocks[] |
string CIDR block. |
v6CidrBlocks[] |
string IPv6 not available yet. |
routeTableId |
string ID of route table the subnet is linked to. |
dhcpOptions |
DHCP options for the subnet. |
DhcpOptions
Field |
Description |
domainNameServers[] |
string A list of DHCP servers for this subnet. |
domainName |
string A domain name to us as a suffix when resolving host names in this subnet. |
ntpServers[] |
string List of NTP servers for this subnet. |