Sign in

v1

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

Creates a new private connection that can be used for accessing private Clouds.

post/v1/{+parent}/privateConnections

Path parameters

parentstring required

Required. The resource name of the location to create the new private connection in. Private connection is a regional 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/us-central1

Query parameters

privateConnectionIdstring

Required. The user-provided identifier of the new private connection. This identifier must be unique among private connection 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

updateTimestring google-datetime

Output only. Last update time of this resource.

vmwareEngineNetworkCanonicalstring

Output only. The canonical name of the VMware Engine network in the form: projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}

descriptionstring

Optional. User-provided description for this private connection.

state'STATE_UNSPECIFIED' | 'CREATING' | 'ACTIVE' | 'UPDATING' | 'DELETING' | 'UNPROVISIONED' | 'FAILED'

Output only. State of the private connection.

vmwareEngineNetworkstring

Required. The relative resource name of Legacy VMware Engine network. Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id} where {project}, {location} will be same as specified in private connection resource name and {vmware_engine_network_id} will be in the form of {location}-default e.g. projects/project/locations/us-central1/vmwareEngineNetworks/us-central1-default.

type'TYPE_UNSPECIFIED' | 'PRIVATE_SERVICE_ACCESS' | 'NETAPP_CLOUD_VOLUMES' | 'DELL_POWERSCALE' | 'THIRD_PARTY_SERVICE'

Required. Private connection type.

uidstring

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

routingMode'ROUTING_MODE_UNSPECIFIED' | 'GLOBAL' | 'REGIONAL'

Optional. Routing Mode. Default value is set to GLOBAL. For type = PRIVATE_SERVICE_ACCESS, this field can be set to GLOBAL or REGIONAL, for other types only GLOBAL is supported.

namestring

Output only. The resource name of the private connection. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/privateConnections/my-connection

peeringIdstring

Output only. VPC network peering id between given network VPC and VMwareEngineNetwork.

serviceNetworkstring

Required. Service network to create private connection. Specify the name in the following form: projects/{project}/global/networks/{network_id} For type = PRIVATE_SERVICE_ACCESS, this field represents servicenetworking VPC, e.g. projects/project-tp/global/networks/servicenetworking. For type = NETAPP_CLOUD_VOLUME, this field represents NetApp service VPC, e.g. projects/project-tp/global/networks/netapp-tenant-vpc. For type = DELL_POWERSCALE, this field represent Dell service VPC, e.g. projects/project-tp/global/networks/dell-tenant-vpc. For type= THIRD_PARTY_SERVICE, this field could represent a consumer VPC or any other producer VPC to which the VMware Engine Network needs to be connected, e.g. projects/project/global/networks/vpc.

createTimestring google-datetime

Output only. Creation time of this resource.

peeringState'PEERING_STATE_UNSPECIFIED' | 'PEERING_ACTIVE' | 'PEERING_INACTIVE'

Output only. Peering state between service network and VMware Engine network.

Response

Successful response