GOgoogle
publicAdvertisedPrefixes

PATCH /projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}

Changed on

Patches the specified Router resource with the data included in the request. This method supportsPATCH semantics and usesJSON merge patch format and processing rules.

Request

  • Base URL
    https://compute.googleapis.com/compute/v1
  • URL
    https://compute.googleapis.com/compute/v1/projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}
  • Auth
    • OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/cloud-platform
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/compute
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/compute

Path parameters

projectstring required

Project ID for this request.

publicAdvertisedPrefixstring required

Name of the PublicAdvertisedPrefix resource to patch.

Query parameters

requestIdstring

An optional 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.

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).

Request body

byoipApiVersion'V1' | 'V2'

Output only. [Output Only] The version of BYOIP API.

creationTimestampstring

Output only. [Output Only] Creation timestamp inRFC3339 text format.

descriptionstring

An optional description of this resource. Provide this property when you create the resource.

dnsVerificationIpstring

The address to be used for reverse DNS verification.

fingerprintstring byte

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 new PublicAdvertisedPrefix. An up-to-date fingerprint must be provided in order to update thePublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet.

To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix.

idstring uint64

Output only. [Output Only] The unique identifier for the resource type. The server generates this identifier.

ipCidrRangestring

The address range, in CIDR format, represented by this public advertised prefix.

ipv6AccessType'EXTERNAL' | 'INTERNAL'

The internet access type for IPv6 Public Advertised Prefixes.

kindstring

Output only. [Output Only] Type of the resource. Alwayscompute#publicAdvertisedPrefix for public advertised prefixes.

namestring

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

pdpScope'GLOBAL' | 'GLOBAL_AND_REGIONAL' | 'REGIONAL'

Specifies how child public delegated prefix will be scoped. It could be one of following values:

 - `REGIONAL`: The public delegated prefix is regional only. The
 provisioning will take a few minutes.
 - `GLOBAL`: The public delegated prefix is global only. The
 provisioning will take ~4 weeks.
 - `GLOBAL_AND_REGIONAL` [output only]: The public delegated prefixes is
  BYOIP V1 legacy prefix. This is output only value and no longer
  supported in BYOIP V2.
selfLinkstring

Output only. [Output Only] Server-defined URL for the resource.

sharedSecretstring

[Output Only] The shared secret to be used for reverse DNS verification.

status'ANNOUNCED_TO_INTERNET' | 'INITIAL' | 'PREFIX_CONFIGURATION_COMPLETE' | 'PREFIX_CONFIGURATION_IN_PROGRESS' | 'PREFIX_REMOVAL_IN_PROGRESS' | 'PTR_CONFIGURED' | 'READY_TO_ANNOUNCE' | 'REVERSE_DNS_LOOKUP_FAILED' | 'VALIDATED'

The status of the public advertised prefix. Possible values include:

 - `INITIAL`: RPKI validation is complete.
 - `PTR_CONFIGURED`: User has configured the PTR.
 - `VALIDATED`: Reverse DNS lookup is successful.
 - `REVERSE_DNS_LOOKUP_FAILED`: Reverse DNS lookup failed.
 - `PREFIX_CONFIGURATION_IN_PROGRESS`: The prefix is being
 configured.
 - `PREFIX_CONFIGURATION_COMPLETE`: The prefix is fully configured.
 - `PREFIX_REMOVAL_IN_PROGRESS`: The prefix is being removed.

Response

Successful response

clientOperationIdstring

[Output Only] The value of requestId if you provided it in the request. Not present otherwise.

creationTimestampstring

[Deprecated] This field is deprecated.

descriptionstring

[Output Only] A textual description of the operation, which is set when the operation is created.

endTimestring

[Output Only] The time that this operation was completed. This value is inRFC3339 text format.

httpErrorMessagestring

[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.

httpErrorStatusCodeinteger

[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.

idstring uint64

[Output Only] The unique identifier for the operation. This identifier is defined by the server.

insertTimestring

[Output Only] The time that this operation was requested. This value is inRFC3339 text format.

kindstring

Output only. [Output Only] Type of the resource. Always compute#operation for Operation resources.

namestring

[Output Only] Name of the operation.

operationGroupIdstring

Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a bulkInsert API request.

operationTypestring

[Output Only] The type of operation, such as insert, update, or delete, and so on.

progressinteger

[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

regionstring

[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

selfLinkstring

[Output Only] Server-defined URL for the resource.

startTimestring

[Output Only] The time that this operation was started by the server. This value is inRFC3339 text format.

status'DONE' | 'PENDING' | 'RUNNING'

[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.

statusMessagestring

[Output Only] An optional textual description of the current status of the operation.

targetIdstring uint64

[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

targetLinkstring

[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.

userstring

[Output Only] User who requested the operation, for example: user@example.com or alice_smith_identifier (global/workforcePools/example-com-us-employees).

zonestring

[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Changes

  • 8b85e897d3dcRevision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2c

  • 48929bf89eebRevision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2c