v1

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

Creates a new ExternalAddress resource in a given private cloud. The network policy that corresponds to the private cloud must have the external IP address network service enabled (NetworkPolicy.external_ip).

post/v1/{+parent}/externalAddresses

Path parameters

parentstring required

Required. The resource name of the private cloud to create a new external IP address in. 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-a/privateClouds/my-cloud

Query parameters

externalAddressIdstring

Required. The user-provided identifier of the ExternalAddress to be created. This identifier must be unique among ExternalAddress 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 the 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

namestring

Output only. Identifier. The resource name of this external IP address. 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-a/privateClouds/my-cloud/externalAddresses/my-address

uidstring

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

internalIpstring

The internal IP address of a workload VM.

externalIpstring

Output only. The external IP address of a workload VM.

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

Output only. The state of the resource.

descriptionstring

User-provided description for this resource.

createTimestring google-datetime

Output only. Creation time of this resource.

updateTimestring google-datetime

Output only. Last update time of this resource.

Response

Successful response