Addresses: aggregatedList

Requires authorization

Retrieves an aggregated list of addresses.


HTTP request



Parameter name Value Description
Path parameters
project string Project ID for this request.
Optional query parameters
filter string Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResults unsigned integer 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)
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.
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.


This request requires authorization with at least one of the following scopes (read more about authentication and authorization).


Request body

Do not supply a request body with this method.


If successful, this method returns a response body with the following structure:

  "kind": "compute#addressAggregatedList",
  "id": string,
  "items": {
    (key): {
      "addresses": [
          "kind": "compute#address",
          "id": unsigned long,
          "creationTimestamp": string,
          "name": string,
          "description": string,
          "address": string,
          "status": string,
          "region": string,
          "selfLink": string,
          "users": [
          "ipVersion": string
      "warning": {
        "code": string,
        "message": string,
        "data": [
            "key": string,
            "value": string
  "nextPageToken": string,
  "selfLink": string
Property name Value Description Notes
kind string [Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses.
id string [Output Only] Unique identifier for the resource; defined by the server.
items object [Output Only] A map of scoped address lists.
items.(key) nested object [Output Only] Name of the scope containing this set of addresses.
items.(key).addresses[] list [Output Only] List of addresses contained in this scope.
items.(key).warning object [Output Only] Informational warning which replaces the list of addresses when the list is empty.
items.(key).warning.code string [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
items.(key).warning.message string [Output Only] A human-readable description of the warning code.
items.(key)[] list [Output Only] Metadata about this warning in key: value format. For example:
"data": [ { "key": "scope", "value": "zones/us-east1-d" }
items.(key)[].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).
items.(key)[].value string [Output Only] A warning data value corresponding to the key.
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.
items.(key).addresses[].kind string [Output Only] Type of the resource. Always compute#address for addresses.
items.(key).addresses[].id unsigned long [Output Only] The unique identifier for the resource. This identifier is defined by the server.
items.(key).addresses[].creationTimestamp string [Output Only] Creation timestamp in RFC3339 text format.
items.(key).addresses[].status string [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
items.(key).addresses[].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.(key).addresses[].description string An optional description of this resource. Provide this property when you create the resource.
items.(key).addresses[].address string The static external IP address represented by this resource.
items.(key).addresses[].region string [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
items.(key).addresses[].users[] list [Output Only] The URLs of the resources that are using this address.
items.(key).addresses[].ipVersion string The IP Version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address.

Send feedback about...

Compute Engine