Some or all of the information on this page might not apply to Trusted Cloud by S3NS.

PublicDelegatedPrefix

JSON representation
Status
PublicDelegatedSubPrefix
- JSON representation
Status
Mode
ByoipApiVersion

A PublicDelegatedPrefix resource represents an IP block within a PublicAdvertisedPrefix that is configured within a single cloud scope (global or region). IPs in the block can be allocated to resources within that scope. Public delegated prefixes may be further broken up into smaller IP blocks in the same scope as the parent block.

JSON representation

JSON representation
{ "kind": string, "id": string, "creationTimestamp": string, "name": string, "description": string, "selfLink": string, "region": string, "ipCidrRange": string, "status": enum (`Status`), "parentPrefix": string, "publicDelegatedSubPrefixs": [ { object (`PublicDelegatedSubPrefix`) } ], "isLiveMigration": boolean, "fingerprint": string, "mode": enum (`Mode`), "allocatablePrefixLength": integer, "byoipApiVersion": enum (`ByoipApiVersion`) }

{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "selfLink": string,
  "region": string,
  "ipCidrRange": string,
  "status": enum (Status),
  "parentPrefix": string,
  "publicDelegatedSubPrefixs": [
    {
      object (PublicDelegatedSubPrefix)
    }
  ],
  "isLiveMigration": boolean,
  "fingerprint": string,
  "mode": enum (Mode),
  "allocatablePrefixLength": integer,
  "byoipApiVersion": enum (ByoipApiVersion)
}

Fields
`kind`	`string` [Output Only] Type of the resource. Always `compute#publicDelegatedPrefix` for public delegated prefixes.
`id`	`string (uint64 format)` [Output Only] The unique identifier for the resource type. The server generates this identifier.
`creationTimestamp`	`string` [Output Only] Creation timestamp in RFC3339 text format.
`name`	`string` Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. 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.
`description`	`string` An optional description of this resource. Provide this property when you create the resource.
`selfLink`	`string` [Output Only] Server-defined URL for the resource.
`region`	`string` [Output Only] URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
`ipCidrRange`	`string` The IP address range, in CIDR format, represented by this public delegated prefix.
`status`	`enum (Status)` [Output Only] The status of the public delegated prefix, which can be one of following values: `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet. `READY_TO_ANNOUNCE` The public delegated prefix is a live migration prefix and is active. `ANNOUNCED` The public delegated prefix is active. `DELETING` The public delegated prefix is being deprovsioned.
`parentPrefix`	`string` The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.
`publicDelegatedSubPrefixs[]`	`object (PublicDelegatedSubPrefix)` The list of sub public delegated prefixes that exist for this public delegated prefix.
`isLiveMigration`	`boolean` If true, the prefix will be live migrated.
`fingerprint`	`string (bytes format)` 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 `PublicDelegatedPrefix` . An up-to-date fingerprint must be provided in order to update the `PublicDelegatedPrefix` , otherwise the request will fail with error `412 conditionNotMet` . To see the latest fingerprint, make a `get()` request to retrieve a PublicDelegatedPrefix. A base64-encoded string.
`mode`	`enum (Mode)` The public delegated prefix mode for IPv6 only.
`allocatablePrefixLength`	`integer` The allocatable prefix length supported by this public delegated prefix. This field is optional and cannot be set for prefixes in DELEGATION mode. It cannot be set for IPv4 prefixes either, and it always defaults to 32.
`byoipApiVersion`	`enum (ByoipApiVersion)` [Output Only] The version of BYOIP API.

Status

Possible statuses of the public delegated prefix.

Enums
`INITIALIZING`	The public delegated prefix is being initialized and addresses cannot be created yet.
`READY_TO_ANNOUNCE`	The public delegated prefix is currently withdrawn but ready to be announced.
`ANNOUNCED`	The public delegated prefix is active.
`DELETING`	The public delegated prefix is being deprovsioned.
`ANNOUNCED_TO_INTERNET`	The prefix is announced to Internet and within Google.
`ANNOUNCED_TO_GOOGLE`	The prefix is announced within Google network.

PublicDelegatedSubPrefix

Represents a sub PublicDelegatedPrefix.

JSON representation

JSON representation
{ "name": string, "description": string, "region": string, "status": enum (`Status`), "ipCidrRange": string, "delegateeProject": string, "isAddress": boolean, "mode": enum (`Mode`), "allocatablePrefixLength": integer }

{
  "name": string,
  "description": string,
  "region": string,
  "status": enum (Status),
  "ipCidrRange": string,
  "delegateeProject": string,
  "isAddress": boolean,
  "mode": enum (Mode),
  "allocatablePrefixLength": integer
}

Fields
`name`	`string` The name of the sub public delegated prefix.
`description`	`string` An optional description of this resource. Provide this property when you create the resource.
`region`	`string` [Output Only] The region of the sub public delegated prefix if it is regional. If absent, the sub prefix is global.
`status`	`enum (Status)` [Output Only] The status of the sub public delegated prefix.
`ipCidrRange`	`string` The IP address range, in CIDR format, represented by this sub public delegated prefix.
`delegateeProject`	`string` Name of the project scoping this PublicDelegatedSubPrefix.
`isAddress`	`boolean` Whether the sub prefix is delegated to create Address resources in the delegatee project.
`mode`	`enum (Mode)` The PublicDelegatedSubPrefix mode for IPv6 only.
`allocatablePrefixLength`	`integer` The allocatable prefix length supported by this PublicDelegatedSubPrefix.

Status

Possible statuses of the sub public delegated prefix. INACTIVE: The public delegated prefix is inactive. ACTIVE: The public delegated prefix is active.

Enums
`INACTIVE`
`ACTIVE`

Mode

Possible modes of the public delegated prefix.

Enums
`DELEGATION`	The public delegated prefix is used for further sub-delegation only. Such prefixes cannot set allocatablePrefixLength.
`EXTERNAL_IPV6_FORWARDING_RULE_CREATION`	The public delegated prefix is used for creating forwarding rules only. Such prefixes cannot set publicDelegatedSubPrefixes.

ByoipApiVersion

The version of BYOIP API

Enums
`V1`	This public delegated prefix usually takes 4 weeks to delete, and the BGP status cannot be changed. Announce and Withdraw APIs can not be used on this prefix.
`V2`	This public delegated prefix takes minutes to delete. Announce and Withdraw APIs can be used on this prefix to change the BGP status.