Method: resourcePolicies.aggregatedList

HTTP request
Path parameters
Query parameters
Request body
Response body
- JSON representation
Authorization Scopes
IAM Permissions

Retrieves an aggregated list of resource policies.

HTTP request

GET https://compute.googleapis.com/compute/v1/projects/{project}/aggregated/resourcePolicies

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`project`	`string` Project ID for this request.

project

string

Project ID for this request.

Query parameters

Parameters
`maxResults`	`number (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. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison 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`. 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)`.
`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.

Request body

The request body must be empty.

Response body

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

JSON representation

JSON representation
{ "id": string, "items": [ { "scopeName": string, "resourcePolicies": [ { "id": string, "creationTimestamp": string, "selfLink": string, "region": string, "description": string, "name": string, "status": enum, "kind": string, "snapshotSchedulePolicy": { "schedule": { // Union field `policy` can be only one of the following: "hourlySchedule": { "hoursInCycle": number, "startTime": string, "duration": string }, "dailySchedule": { "daysInCycle": number, "startTime": string, "duration": string }, "weeklySchedule": { "dayOfWeeks": [ { "day": enum, "startTime": string, "duration": string } ] } // End of list of possible types for union field `policy`. }, "retentionPolicy": { "maxRetentionDays": number, "onSourceDiskDelete": enum }, "snapshotProperties": { "labels": { string: string, ... }, "storageLocations": [ string ], "guestFlush": boolean } } } ], "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } } ], "nextPageToken": string, "selfLink": string, "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] }, "etag": string, "kind": string }

{
  "id": string,
  "items": [
    {
      "scopeName": string,
      "resourcePolicies": [
        {
          "id": string,
          "creationTimestamp": string,
          "selfLink": string,
          "region": string,
          "description": string,
          "name": string,
          "status": enum,
          "kind": string,
          "snapshotSchedulePolicy": {
            "schedule": {

              // Union field policy can be only one of the following:
              "hourlySchedule": {
                "hoursInCycle": number,
                "startTime": string,
                "duration": string
              },
              "dailySchedule": {
                "daysInCycle": number,
                "startTime": string,
                "duration": string
              },
              "weeklySchedule": {
                "dayOfWeeks": [
                  {
                    "day": enum,
                    "startTime": string,
                    "duration": string
                  }
                ]
              }
              // End of list of possible types for union field policy.
            },
            "retentionPolicy": {
              "maxRetentionDays": number,
              "onSourceDiskDelete": enum
            },
            "snapshotProperties": {
              "labels": {
                string: string,
                ...
              },
              "storageLocations": [
                string
              ],
              "guestFlush": boolean
            }
          }
        }
      ],
      "warning": {
        "code": enum,
        "message": string,
        "data": [
          {
            "key": string,
            "value": string
          }
        ]
      }
    }
  ],
  "nextPageToken": string,
  "selfLink": string,
  "warning": {
    "code": enum,
    "message": string,
    "data": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "etag": string,
  "kind": string
}

Fields
`id`	`string` [Output Only] Unique identifier for the resource; defined by the server.
`items[]`	`object` A list of ResourcePolicy resources.
`items[].scopeName`	`string` Name of the scope containing this set of resourcePolicies.
`items[].resourcePolicies[]`	`object` A list of resourcePolicies contained in this scope.
`items[].resourcePolicies[].id`	`string (fixed64 format)` [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`items[].resourcePolicies[].creationTimestamp`	`string` [Output Only] Creation timestamp in RFC3339 text format.
`items[].resourcePolicies[].selfLink`	`string` [Output Only] Server-defined fully-qualified URL for this resource.
`items[].resourcePolicies[].region`	`string`
`items[].resourcePolicies[].description`	`string`
`items[].resourcePolicies[].name`	`string` The name of the resource, provided by the client when initially creating the resource. The resource 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[].resourcePolicies[].snapshotSchedulePolicy`	`object` Resource policy for persistent disks for creating snapshots.
`items[].resourcePolicies[].snapshotSchedulePolicy.schedule`	`object` A Vm Maintenance Policy specifies what kind of infrastructure maintenance we are allowed to perform on this VM and when. Schedule that is applied to disks covered by this policy.
`items[].resourcePolicies[].snapshotSchedulePolicy.schedule.hourlySchedule`	`object`
`items[].resourcePolicies[].snapshotSchedulePolicy.schedule.hourlySchedule.hoursInCycle`	`number` Allows to define schedule that runs every nth hour.
`items[].resourcePolicies[].snapshotSchedulePolicy.schedule.hourlySchedule.startTime`	`string` Time within the window to start the operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT.
`items[].resourcePolicies[].snapshotSchedulePolicy.schedule.hourlySchedule.duration`	`string` [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.
`items[].resourcePolicies[].snapshotSchedulePolicy.schedule.dailySchedule`	`object`
`items[].resourcePolicies[].snapshotSchedulePolicy.schedule.dailySchedule.daysInCycle`	`number` Defines a schedule that runs every nth day of the month.
`items[].resourcePolicies[].snapshotSchedulePolicy.schedule.dailySchedule.startTime`	`string` instances.start time of the window. This must be in UTC format that resolves to one of `00:00`, `04:00`, `08:00`, `12:00`, `16:00`, or `20:00`. For example, both `13:00-5` and `08:00` are valid.
`items[].resourcePolicies[].snapshotSchedulePolicy.schedule.dailySchedule.duration`	`string` [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.
`items[].resourcePolicies[].snapshotSchedulePolicy.schedule.weeklySchedule`	`object`
`items[].resourcePolicies[].snapshotSchedulePolicy.schedule.weeklySchedule.dayOfWeeks[]`	`object` Up to 7 intervals/windows, one for each day of the week.
`items[].resourcePolicies[].snapshotSchedulePolicy.schedule.weeklySchedule.dayOfWeeks[].day`	`enum` Allows to define schedule that runs specified day of the week.
`items[].resourcePolicies[].snapshotSchedulePolicy.schedule.weeklySchedule.dayOfWeeks[].startTime`	`string` Time within the window to start the operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT.
`items[].resourcePolicies[].snapshotSchedulePolicy.schedule.weeklySchedule.dayOfWeeks[].duration`	`string` [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.
`items[].resourcePolicies[].snapshotSchedulePolicy.retentionPolicy`	`object` Retention policy applied to snapshots created by this resource policy.
`items[].resourcePolicies[].snapshotSchedulePolicy.retentionPolicy.maxRetentionDays`	`number` Maximum age of the snapshot that is allowed to be kept.
`items[].resourcePolicies[].snapshotSchedulePolicy.retentionPolicy.onSourceDiskDelete`	`enum` Specifies the behavior to apply to scheduled snapshots when the source disk is deleted.
`items[].resourcePolicies[].snapshotSchedulePolicy.snapshotProperties`	`object` Properties with which snapshots are created such as labels, encryption keys.
`items[].resourcePolicies[].snapshotSchedulePolicy.snapshotProperties.labels`	`map (key: string, value: string)` Labels to apply to scheduled snapshots. These can be later modified by the `setLabels` method. Label values may be empty. An object containing a list of `"key": value` pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
`items[].resourcePolicies[].snapshotSchedulePolicy.snapshotProperties.storageLocations[]`	`string` Cloud Storage bucket storage location of the auto snapshot (regional or multi-regional).
`items[].resourcePolicies[].snapshotSchedulePolicy.snapshotProperties.guestFlush`	`boolean` Indication to perform a ‘guest aware’ snapshot.
`items[].resourcePolicies[].status`	`enum` [Output Only] The status of resource policy creation.
`items[].resourcePolicies[].kind`	`string` [Output Only] Type of the resource. Always `compute#resource_policies` for resource policies.
`items[].warning`	`object` Informational warning which replaces the list of resourcePolicies when the list is empty.
`items[].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.
`items[].warning.message`	`string` [Output Only] A human-readable description of the warning code.
`items[].warning.data[]`	`object` [Output Only] Metadata about this warning in `key: value` format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
`items[].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).
`items[].warning.data[].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.
`selfLink`	`string` [Output Only] Server-defined URL for this resource.
`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.
`etag`	`string`
`kind`	`string` Type of resource.

Authorization Scopes

Requires one of the following OAuth scopes:

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 Google IAM permissions:

compute.resourcePolicies.list

Was this page helpful? Let us know how we did:

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated October 16, 2019.