List
|
|||||
|
|
Retrieves a list of subnetworks available to the specified project
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your data across Google Cloud Platform services
- View and manage your Google Compute Engine resources
- View your Google Compute Engine resources
Input
This building block consumes 6 input parameters
Name | Format | Description |
---|---|---|
project Required |
STRING |
Project ID for this request |
region Required |
STRING |
Name of the region scoping this request |
filter |
STRING |
A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) |
maxResults |
INTEGER |
The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) |
orderBy |
STRING |
Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported |
pageToken |
STRING |
Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results |
= Parameter name
= Format
project STRING Required Project ID for this request |
region STRING Required Name of the region scoping this request |
filter STRING A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) |
maxResults INTEGER The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) |
orderBy STRING Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported |
pageToken STRING Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results |
Output
This building block provides 27 output parameters
Name | Format | Description |
---|---|---|
id |
STRING |
[Output Only] Unique identifier for the resource; defined by the server |
items[] |
OBJECT |
Represents a Subnetwork resource. A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for beta.subnetworks ==) (== resource_for v1.subnetworks ==) |
items[].creationTimestamp |
STRING |
[Output Only] Creation timestamp in RFC3339 text format |
items[].description |
STRING |
An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time |
items[].enableFlowLogs |
BOOLEAN |
Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is to disable flow logging |
items[].fingerprint |
BINARY |
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a Subnetwork. An up-to-date fingerprint must be provided in order to update the Subnetwork, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a Subnetwork |
items[].gatewayAddress |
STRING |
[Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork |
items[].id |
INTEGER |
[Output Only] The unique identifier for the resource. This identifier is defined by the server |
items[].ipCidrRange |
STRING |
The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field can be set only at resource creation time |
items[].kind |
STRING |
[Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources |
items[].name |
STRING |
The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression |
items[].network |
STRING |
The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks. This field can be set only at resource creation time |
items[].privateIpGoogleAccess |
BOOLEAN |
Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess |
items[].region |
STRING |
URL of the region where the Subnetwork resides. This field can be set only at resource creation time |
items[].secondaryIpRanges[] |
OBJECT |
Represents a secondary IP range of a subnetwork |
items[].secondaryIpRanges[].ipCidrRange |
STRING |
The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network. Only IPv4 is supported |
items[].secondaryIpRanges[].rangeName |
STRING |
The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork |
items[].selfLink |
STRING |
[Output Only] Server-defined URL for the resource |
kind |
STRING |
[Output Only] Type of resource. Always compute#subnetworkList for lists of subnetworks |
nextPageToken |
STRING |
[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results |
selfLink |
STRING |
[Output Only] Server-defined URL for this resource |
warning |
OBJECT |
[Output Only] Informational warning message |
warning.code |
ENUMERATION |
[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response |
warning.data[] |
OBJECT |
|
warning.data[].key |
STRING |
[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding) |
warning.data[].value |
STRING |
[Output Only] A warning data value corresponding to the key |
warning.message |
STRING |
[Output Only] A human-readable description of the warning code |
= Parameter name
= Format
id STRING [Output Only] Unique identifier for the resource; defined by the server |
items[] OBJECT Represents a Subnetwork resource. A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for beta.subnetworks ==) (== resource_for v1.subnetworks ==) |
items[].creationTimestamp STRING [Output Only] Creation timestamp in RFC3339 text format |
items[].description STRING An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time |
items[].enableFlowLogs BOOLEAN Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is to disable flow logging |
items[].fingerprint BINARY Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a Subnetwork. An up-to-date fingerprint must be provided in order to update the Subnetwork, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a Subnetwork |
items[].gatewayAddress STRING [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork |
items[].id INTEGER [Output Only] The unique identifier for the resource. This identifier is defined by the server |
items[].ipCidrRange STRING The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field can be set only at resource creation time |
items[].kind STRING [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources |
items[].name STRING The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression |
items[].network STRING The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks. This field can be set only at resource creation time |
items[].privateIpGoogleAccess BOOLEAN Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess |
items[].region STRING URL of the region where the Subnetwork resides. This field can be set only at resource creation time |
items[].secondaryIpRanges[] OBJECT Represents a secondary IP range of a subnetwork |
items[].secondaryIpRanges[].ipCidrRange STRING The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network. Only IPv4 is supported |
items[].secondaryIpRanges[].rangeName STRING The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork |
items[].selfLink STRING [Output Only] Server-defined URL for the resource |
kind STRING [Output Only] Type of resource. Always compute#subnetworkList for lists of subnetworks |
nextPageToken STRING [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results |
selfLink STRING [Output Only] Server-defined URL for this resource |
warning OBJECT [Output Only] Informational warning message |
warning.code ENUMERATION [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response |
warning.data[] OBJECT |
warning.data[].key STRING [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding) |
warning.data[].value STRING [Output Only] A warning data value corresponding to the key |
warning.message STRING [Output Only] A human-readable description of the warning code |