Sign in

v1

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

Creates a new RegionalEndpoint in a given project and location.

post/v1/{+parent}/regionalEndpoints

Path parameters

parentstring required

Required. The parent resource's name of the RegionalEndpoint.

Query parameters

regionalEndpointIdstring

Required. Unique id of the Regional Endpoint to be created. @pattern: ^-a-z0-9[a-z0-9]$

requestIdstring

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. 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 the original operation with the same request ID was received, and if so, ignores 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).

Request body

addressstring

Optional. The IP Address of the Regional Endpoint. When no address is provided, an IP from the subnetwork is allocated. Use one of the following formats: * IPv4 address as in 10.0.0.1 * Address resource URI as in projects/{project}/regions/{region}/addresses/{address_name} for an IPv4 or IPv6 address.

networkstring

Optional. The name of the VPC network for this private regional endpoint. Format: projects/{project}/global/networks/{network}

namestring

Output only. The name of a RegionalEndpoint. Pattern: projects/{project}/locations/{location}/regionalEndpoints/^[-a-z0-9](?:[-a-z0-9]{0,44})[a-z0-9]$.

accessType'ACCESS_TYPE_UNSPECIFIED' | 'GLOBAL' | 'REGIONAL'

Required. The access type of this regional endpoint. This field is reflected in the PSC Forwarding Rule configuration to enable global access.

labelsobject

User-defined labels.

targetGoogleApistring

Required. The service endpoint this private regional endpoint connects to. Format: {apiname}.{region}.p.rep.googleapis.com Example: "cloudkms.us-central1.p.rep.googleapis.com".

subnetworkstring

Optional. The name of the subnetwork from which the IP address will be allocated. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork}

pscForwardingRulestring

Output only. The resource reference of the PSC Forwarding Rule created on behalf of the customer. Format: //compute.googleapis.com/projects/{project}/regions/{region}/forwardingRules/{forwarding_rule_name}

ipAddressstring

Output only. The literal IP address of the PSC Forwarding Rule created on behalf of the customer. This field is deprecated. Use address instead.

updateTimestring google-datetime

Output only. Time when the RegionalEndpoint was updated.

createTimestring google-datetime

Output only. Time when the RegionalEndpoint was created.

descriptionstring

Optional. A description of this resource.

Response

Successful response