- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Retrieves an aggregated list of addresses.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
.
HTTP request
GET https://compute.googleapis.com/compute/v1/projects/{project}/aggregated/addresses
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
Query parameters
Parameters | |
---|---|
maxResults |
The maximum number of results per page that should be returned. If the number of available results is larger than |
pageToken |
Specifies a page token to use. Set |
filter |
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 For example, if you are filtering Compute Engine instances, you can exclude instances named The
You can also filter nested fields. For example, you could specify To filter on multiple expressions, provide each separate expression within parentheses. For example:
By default, each expression is an
If you want to use a regular expression, use the
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 You cannot combine constraints on multiple fields using regular expressions. |
orderBy |
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 Currently, only sorting by |
returnPartialSuccess |
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. |
includeAllScopes |
Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. |
serviceProjectNumber |
The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. |
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": { string: { "addresses": [ { "kind": string, "id": string, "creationTimestamp": string, "name": string, "description": string, "address": string, "prefixLength": integer, "status": enum, "region": string, "selfLink": string, "users": [ string ], "networkTier": enum, "labels": { string: string, ... }, "labelFingerprint": string, "ipVersion": enum, "addressType": enum, "purpose": enum, "subnetwork": string, "network": string, "ipv6EndpointType": enum } ], "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } }, ... }, "nextPageToken": string, "selfLink": string, "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] }, "unreachables": [ string ] } |
Fields | |
---|---|
kind |
[Output Only] Type of resource. Always |
id |
[Output Only] Unique identifier for the resource; defined by the server. |
items |
A list of AddressesScopedList resources. Key: [Output Only] Name of the scope containing this set of addresses. |
items.addresses[] |
[Output Only] A list of addresses contained in this scope. |
items.addresses[].kind |
[Output Only] Type of the resource. Always |
items.addresses[].id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
items.addresses[].creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
items.addresses[].name |
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 |
items.addresses[].description |
An optional description of this resource. Provide this field when you create the resource. |
items.addresses[].address |
The static IP address represented by this resource. |
items.addresses[].prefixLength |
The prefix length if the resource represents an IP range. |
items.addresses[].status |
[Output Only] The status of the address, which can be one of |
items.addresses[].region |
[Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. This field is not applicable to global addresses. |
items.addresses[].selfLink |
[Output Only] Server-defined URL for the resource. |
items.addresses[].users[] |
[Output Only] The URLs of the resources that are using this address. |
items.addresses[].networkTier |
This signifies the networking tier used for configuring this address and can only take the following values: If this field is not specified, it is assumed to be |
items.addresses[].labels |
Labels for this resource. These can only be added or modified by the |
items.addresses[].labelFingerprint |
A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error To see the latest fingerprint, make a A base64-encoded string. |
items.addresses[].ipVersion |
The IP version that will be used by this address. Valid options are |
items.addresses[].addressType |
The type of address to reserve, either |
items.addresses[].purpose |
The purpose of this resource, which can be one of the following values:
|
items.addresses[].subnetwork |
The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with |
items.addresses[].network |
The URL of the network in which to reserve the address. This field can only be used with |
items.addresses[].ipv6EndpointType |
The endpoint type of this address, which should be |
items.warning |
[Output Only] Informational warning which replaces the list of addresses when the list is empty. |
items.warning.code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
items.warning.message |
[Output Only] A human-readable description of the warning code. |
items.warning.data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
items.warning.data[].key |
[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 |
items.warning.data[].value |
[Output Only] A warning data value corresponding to the key. |
nextPageToken |
[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than |
selfLink |
[Output Only] Server-defined URL for this resource. |
warning |
[Output Only] Informational warning message. |
warning.code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warning.message |
[Output Only] A human-readable description of the warning code. |
warning.data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
warning.data[].key |
[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 |
warning.data[].value |
[Output Only] A warning data value corresponding to the key. |
unreachables[] |
[Output Only] Unreachable resources. |
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.addresses.list
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.