Method: globalPublicDelegatedPrefixes.list

Lists the global PublicDelegatedPrefixes for a project.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/global/publicDelegatedPrefixes

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.

Query parameters

Parameters
maxResults

integer (uint32 format)

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
pageToken

string

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter

string

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request.

If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, !=, >, <, <=, >= or :.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use:

labels.owner:*

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example:

(scheduling.automaticRestart = true)
(cpuPlatform = "Intel Skylake")

By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example:

(cpuPlatform = "Intel Skylake") OR
(cpuPlatform = "Intel Broadwell") AND
(scheduling.automaticRestart = true)

If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples:

fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal")

The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field.

For example, to filter for instances that do not end with name "instance", you would use name ne .*instance.

You cannot combine constraints on multiple fields using regular expressions.
orderBy

string

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
returnPartialSuccess

boolean

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation 
{
  "kind": string,
  "id": string,
  "items": [
    {
      "kind": string,
      "id": string,
      "creationTimestamp": string,
      "name": string,
      "description": string,
      "selfLink": string,
      "region": string,
      "ipCidrRange": string,
      "status": enum,
      "parentPrefix": string,
      "publicDelegatedSubPrefixs": [
        {
          "name": string,
          "description": string,
          "region": string,
          "status": enum,
          "ipCidrRange": string,
          "delegateeProject": string,
          "isAddress": boolean,
          "mode": enum,
          "allocatablePrefixLength": integer
        }
      ],
      "isLiveMigration": boolean,
      "fingerprint": string,
      "mode": enum,
      "allocatablePrefixLength": integer,
      "byoipApiVersion": enum
    }
  ],
  "nextPageToken": string,
  "selfLink": string,
  "warning": {
    "code": enum,
    "message": string,
    "data": [
      {
        "key": string,
        "value": string
      }
    ]
  }
}
Fields
kind

string

[Output Only] Type of the resource. Always compute#publicDelegatedPrefixList for public delegated prefixes.
id

string

[Output Only] Unique identifier for the resource; defined by the server.
items[]

object

A list of PublicDelegatedPrefix resources.
items[].kind

string

[Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes.
items[].id

string (uint64 format)

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

string

[Output Only] Creation timestamp in RFC3339 text format.
items[].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.
items[].description

string

An optional description of this resource. Provide this property when you create the resource.
items[].selfLink

string

[Output Only] Server-defined URL for the resource.
items[].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.
items[].ipCidrRange

string

The IP address range, in CIDR format, represented by this public delegated prefix.
items[].status

enum

[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.
items[].parentPrefix

string

The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.
items[].publicDelegatedSubPrefixs[]

object

The list of sub public delegated prefixes that exist for this public delegated prefix.
items[].publicDelegatedSubPrefixs[].name

string

The name of the sub public delegated prefix.
items[].publicDelegatedSubPrefixs[].description

string

An optional description of this resource. Provide this property when you create the resource.
items[].publicDelegatedSubPrefixs[].region

string

[Output Only] The region of the sub public delegated prefix if it is regional. If absent, the sub prefix is global.
items[].publicDelegatedSubPrefixs[].status

enum

[Output Only] The status of the sub public delegated prefix.
items[].publicDelegatedSubPrefixs[].ipCidrRange

string

The IP address range, in CIDR format, represented by this sub public delegated prefix.
items[].publicDelegatedSubPrefixs[].delegateeProject

string

Name of the project scoping this PublicDelegatedSubPrefix.
items[].publicDelegatedSubPrefixs[].isAddress

boolean

Whether the sub prefix is delegated to create Address resources in the delegatee project.
items[].publicDelegatedSubPrefixs[].mode

enum

The PublicDelegatedSubPrefix mode for IPv6 only.
items[].publicDelegatedSubPrefixs[].allocatablePrefixLength

integer

The allocatable prefix length supported by this PublicDelegatedSubPrefix.
items[].isLiveMigration

boolean

If true, the prefix will be live migrated.
items[].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.
items[].mode

enum

The public delegated prefix mode for IPv6 only.
items[].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.
items[].byoipApiVersion

enum

[Output Only] The version of BYOIP API.
nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
warning

object

[Output Only] Informational warning message.
warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
warning.message

string

[Output Only] A human-readable description of the warning code.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: 

"data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }
warning.data[].key

string

[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
warning.data[].value

string

[Output Only] A warning data value corresponding to the key.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute.readonly
  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:

  • compute.globalPublicDelegatedPrefixes.list

To find predefined roles that contain those permissions, see Compute Engine IAM Roles.