v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-135196224.4 KB
projects

Creates a new network peering between the peer network and VMware Engine network provided in a NetworkPeering resource. NetworkPeering is a global resource and location can only be global.

post/v1/{+parent}/networkPeerings

Path parameters

parentstring required

Required. The resource name of the location to create the new network peering in. This value is always global, because NetworkPeering is a global resource. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global

Query parameters

networkPeeringIdstring

Required. The user-provided identifier of the new NetworkPeering. This identifier must be unique among NetworkPeering resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with RFC 1034 (section 3.5)

requestIdstring

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

validateOnlyboolean

Optional. If set to true, only validates the request but doesn’t execute the request. If set to false, validates and executes the request.

Request body

createTimestring google-datetime

Output only. Creation time of this resource.

exportCustomRoutesWithPublicIpboolean

Optional. True if all subnet routes with a public IP address range are exported; false otherwise. The default value is true. IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field.

peerNetworkstring

Required. The relative resource name of the network to peer with a standard VMware Engine network. The provided network can be a consumer VPC network or another standard VMware Engine network. If the peer_network_type is VMWARE_ENGINE_NETWORK, specify the name in the form: projects/{project}/locations/global/vmwareEngineNetworks/{vmware_engine_network_id}. Otherwise specify the name in the form: projects/{project}/global/networks/{network_id}, where {project} can either be a project number or a project ID.

peerMtuinteger

Optional. Maximum transmission unit (MTU) in bytes. The default value is 1500. If a value of 0 is provided for this field, VMware Engine uses the default value instead.

exchangeSubnetRoutesboolean

Optional. True if full mesh connectivity is created and managed automatically between peered networks; false otherwise. Currently this field is always true because Google Compute Engine automatically creates and manages subnetwork routes between two VPC networks when peering state is 'ACTIVE'.

importCustomRoutesWithPublicIpboolean

Optional. True if all subnet routes with public IP address range are imported; false otherwise. The default value is true. IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported to peers and are not controlled by this field.

stateDetailsstring

Output only. Output Only. Details about the current state of the network peering.

importCustomRoutesboolean

Optional. True if custom routes are imported from the peered network; false otherwise. The default value is true.

namestring

Output only. Identifier. The resource name of the network peering. NetworkPeering is a global resource and location can only be global. Resource names are scheme-less URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/networkPeerings/my-peering

exportCustomRoutesboolean

Optional. True if custom routes are exported to the peered network; false otherwise. The default value is true.

vmwareEngineNetworkstring

Required. The relative resource name of the VMware Engine network. Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id} where {project} can either be a project number or a project ID.

uidstring

Output only. System-generated unique identifier for the resource.

updateTimestring google-datetime

Output only. Last update time of this resource.

state'STATE_UNSPECIFIED' | 'INACTIVE' | 'ACTIVE' | 'CREATING' | 'DELETING'

Output only. State of the network peering. This field has a value of 'ACTIVE' when there's a matching configuration in the peer network. New values may be added to this enum when appropriate.

descriptionstring

Optional. User-provided description for this network peering.

peerNetworkType'PEER_NETWORK_TYPE_UNSPECIFIED' | 'STANDARD' | 'VMWARE_ENGINE_NETWORK' | 'PRIVATE_SERVICES_ACCESS' | 'NETAPP_CLOUD_VOLUMES' | 'THIRD_PARTY_SERVICE' | 'DELL_POWERSCALE' | 'GOOGLE_CLOUD_NETAPP_VOLUMES' | 'GOOGLE_CLOUD_FILESTORE_INSTANCES'

Required. The type of the network to peer with the VMware Engine network.

Response

Successful response