- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Returns the specified subnetwork.
HTTP request
GET https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
region |
Name of the region scoping this request. |
subnetwork |
Name of the Subnetwork resource to return. |
Request body
The request body must be empty.
Response body
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.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "kind": string, "id": string, "creationTimestamp": string, "name": string, "description": string, "network": string, "ipCidrRange": string, "reservedInternalRange": string, "gatewayAddress": string, "region": string, "selfLink": string, "privateIpGoogleAccess": boolean, "secondaryIpRanges": [ { "rangeName": string, "ipCidrRange": string, "reservedInternalRange": string } ], "fingerprint": string, "enableFlowLogs": boolean, "privateIpv6GoogleAccess": enum, "ipv6CidrRange": string, "externalIpv6Prefix": string, "internalIpv6Prefix": string, "purpose": enum, "role": enum, "state": enum, "logConfig": { "enable": boolean, "aggregationInterval": enum, "flowSampling": number, "metadata": enum, "metadataFields": [ string ], "filterExpr": string }, "stackType": enum, "ipv6AccessType": enum } |
Fields | |
---|---|
kind |
[Output Only] Type of the resource. Always |
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
name |
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 |
description |
An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time. |
network |
The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time. |
ipCidrRange |
The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, |
reservedInternalRange |
The URL of the reserved internal range. |
gatewayAddress |
[Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork. |
region |
URL of the region where the Subnetwork resides. This field can be set only at resource creation time. |
selfLink |
[Output Only] Server-defined URL for the resource. |
privateIpGoogleAccess |
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 |
secondaryIpRanges[] |
An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with a |
secondaryIpRanges[].rangeName |
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. |
secondaryIpRanges[].ipCidrRange |
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. The range can be any range listed in the Valid ranges list. |
secondaryIpRanges[].reservedInternalRange |
The URL of the reserved internal range. |
fingerprint |
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 To see the latest fingerprint, make a A base64-encoded string. |
enableFlowLogs |
Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in |
privateIpv6GoogleAccess |
This field is for internal use. This field can be both set at resource creation time and updated using |
ipv6CidrRange |
[Output Only] This field is for internal use. |
externalIpv6Prefix |
The external IPv6 address range that is owned by this subnetwork. |
internalIpv6Prefix |
The internal IPv6 address range that is owned by this subnetwork. |
purpose |
The purpose of the resource. This field can be either |
role |
The role of subnetwork. Currently, this field is only used when purpose is set to |
state |
[Output Only] The state of the subnetwork, which can be one of the following values: |
logConfig |
This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging. |
logConfig.enable |
Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in |
logConfig.aggregationInterval |
Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection. |
logConfig.flowSampling |
Can only be specified if VPC flow logging for this subnetwork is enabled. The value of the field must be in [0, 1]. Set the sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default is 0.5 unless otherwise specified by the org policy, which means half of all collected logs are reported. |
logConfig.metadata |
Can only be specified if VPC flow logs for this subnetwork is enabled. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default is |
logConfig.metadataFields[] |
Can only be specified if VPC flow logs for this subnetwork is enabled and "metadata" was set to CUSTOM_METADATA. |
logConfig.filterExpr |
Can only be specified if VPC flow logs for this subnetwork is enabled. The filter expression is used to define which VPC flow logs should be exported to Cloud Logging. |
stackType |
The stack type for the subnet. If set to This field can be both set at resource creation time and updated using |
ipv6AccessType |
The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/compute.readonly
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:
compute.subnetworks.get
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.