Method: resourcePolicies.list

HTTP request
Path parameters
Query parameters
Request body
Response body
- JSON representation
Authorization scopes
IAM Permissions
Try it!

A list all the resource policies that have been configured for the specified project in specified region.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`project`	`string` Project ID for this request.
`region`	`string` Name of the region for this request.

project

string

Project ID for this request.

region

string

Name of the region 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": [ { "snapshotSchedulePolicy": { "schedule": { "hourlySchedule": { "hoursInCycle": integer, "startTime": string, "duration": string }, "dailySchedule": { "daysInCycle": integer, "startTime": string, "duration": string }, "weeklySchedule": { "dayOfWeeks": [ { "day": enum, "startTime": string, "duration": string } ] } }, "retentionPolicy": { "maxRetentionDays": integer, "onSourceDiskDelete": enum }, "snapshotProperties": { "labels": { string: string, ... }, "storageLocations": [ string ], "guestFlush": boolean, "chainName": string } }, "groupPlacementPolicy": { "vmCount": integer, "availabilityDomainCount": integer, "collocation": enum, "gpuTopology": string }, "instanceSchedulePolicy": { "vmStartSchedule": { "schedule": string }, "vmStopSchedule": { "schedule": string }, "timeZone": string, "startTime": string, "expirationTime": string }, "diskConsistencyGroupPolicy": , "workloadPolicy": { "type": enum, "maxTopologyDistance": enum, "acceleratorTopology": string }, "kind": string, "id": string, "creationTimestamp": string, "selfLink": string, "region": string, "description": string, "name": string, "status": enum, "resourceStatus": { "instanceSchedulePolicy": { "nextRunStartTime": string, "lastRunStartTime": string } } } ], "nextPageToken": string, "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] }, "selfLink": string, "etag": string }

JSON representation

{
  "kind": string,
  "id": string,
  "items": [
    {
      "snapshotSchedulePolicy": {
        "schedule": {
          "hourlySchedule": {
            "hoursInCycle": integer,
            "startTime": string,
            "duration": string
          },
          "dailySchedule": {
            "daysInCycle": integer,
            "startTime": string,
            "duration": string
          },
          "weeklySchedule": {
            "dayOfWeeks": [
              {
                "day": enum,
                "startTime": string,
                "duration": string
              }
            ]
          }
        },
        "retentionPolicy": {
          "maxRetentionDays": integer,
          "onSourceDiskDelete": enum
        },
        "snapshotProperties": {
          "labels": {
            string: string,
            ...
          },
          "storageLocations": [
            string
          ],
          "guestFlush": boolean,
          "chainName": string
        }
      },
      "groupPlacementPolicy": {
        "vmCount": integer,
        "availabilityDomainCount": integer,
        "collocation": enum,
        "gpuTopology": string
      },
      "instanceSchedulePolicy": {
        "vmStartSchedule": {
          "schedule": string
        },
        "vmStopSchedule": {
          "schedule": string
        },
        "timeZone": string,
        "startTime": string,
        "expirationTime": string
      },
      "diskConsistencyGroupPolicy": ,
      "workloadPolicy": {
        "type": enum,
        "maxTopologyDistance": enum,
        "acceleratorTopology": string
      },
      "kind": string,
      "id": string,
      "creationTimestamp": string,
      "selfLink": string,
      "region": string,
      "description": string,
      "name": string,
      "status": enum,
      "resourceStatus": {
        "instanceSchedulePolicy": {
          "nextRunStartTime": string,
          "lastRunStartTime": string
        }
      }
    }
  ],
  "nextPageToken": string,
  "warning": {
    "code": enum,
    "message": string,
    "data": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "selfLink": string,
  "etag": string
}

Fields
`kind`	`string` [Output Only] Type of resource.Always `compute#resourcePoliciesList` for listsof resourcePolicies
`id`	`string` [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`items[]`	`object` [Output Only] A list of ResourcePolicy resources.
`items[].snapshotSchedulePolicy`	`object` Resource policy for persistent disks for creating snapshots.
`items[].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[].snapshotSchedulePolicy.schedule.hourlySchedule`	`object`
`items[].snapshotSchedulePolicy.schedule.hourlySchedule.hoursInCycle`	`integer` Defines a schedule with units measured in hours. The value determines how many hours pass between the start of each cycle.
`items[].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[].snapshotSchedulePolicy.schedule.hourlySchedule.duration`	`string` [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.
`items[].snapshotSchedulePolicy.schedule.dailySchedule`	`object`
`items[].snapshotSchedulePolicy.schedule.dailySchedule.daysInCycle`	`integer` Defines a schedule with units measured in days. The value determines how many days pass between the start of each cycle.
`items[].snapshotSchedulePolicy.schedule.dailySchedule.startTime`	`string` 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[].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[].snapshotSchedulePolicy.schedule.weeklySchedule`	`object`
`items[].snapshotSchedulePolicy.schedule.weeklySchedule.dayOfWeeks[]`	`object` Up to 7 intervals/windows, one for each day of the week.
`items[].snapshotSchedulePolicy.schedule.weeklySchedule.dayOfWeeks[].day`	`enum` Defines a schedule that runs on specific days of the week. Specify one or more days. The following options are available: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.
`items[].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[].snapshotSchedulePolicy.schedule.weeklySchedule.dayOfWeeks[].duration`	`string` [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.
`items[].snapshotSchedulePolicy.retentionPolicy`	`object` Retention policy applied to snapshots created by this resource policy.
`items[].snapshotSchedulePolicy.retentionPolicy.maxRetentionDays`	`integer` Maximum age of the snapshot that is allowed to be kept.
`items[].snapshotSchedulePolicy.retentionPolicy.onSourceDiskDelete`	`enum` Specifies the behavior to apply to scheduled snapshots when the source disk is deleted.
`items[].snapshotSchedulePolicy.snapshotProperties`	`object` Properties with which snapshots are created such as labels, encryption keys.
`items[].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.
`items[].snapshotSchedulePolicy.snapshotProperties.storageLocations[]`	`string` Cloud Storage bucket storage location of the auto snapshot (regional or multi-regional).
`items[].snapshotSchedulePolicy.snapshotProperties.guestFlush`	`boolean` Indication to perform a 'guest aware' snapshot.
`items[].snapshotSchedulePolicy.snapshotProperties.chainName`	`string` Chain name that the snapshot is created in.
`items[].groupPlacementPolicy`	`object` Resource policy for instances for placement configuration.
`items[].groupPlacementPolicy.vmCount`	`integer` Number of VMs in this placement group. Google does not recommend that you use this field unless you use a compact policy and you want your policy to work only if it contains this exact number of VMs.
`items[].groupPlacementPolicy.availabilityDomainCount`	`integer` The number of availability domains to spread instances across. If two instances are in different availability domain, they are not in the same low latency network.
`items[].groupPlacementPolicy.collocation`	`enum` Specifies network collocation
`items[].groupPlacementPolicy.gpuTopology`	`string` Specifies the shape of the GPU slice, in slice based GPU families eg. A4X.
`items[].instanceSchedulePolicy`	`object` Resource policy for scheduling instance operations.
`items[].instanceSchedulePolicy.vmStartSchedule`	`object` Specifies the schedule for starting instances.
`items[].instanceSchedulePolicy.vmStartSchedule.schedule`	`string` Specifies the frequency for the operation, using the unix-cron format.
`items[].instanceSchedulePolicy.vmStopSchedule`	`object` Specifies the schedule for stopping instances.
`items[].instanceSchedulePolicy.vmStopSchedule.schedule`	`string` Specifies the frequency for the operation, using the unix-cron format.
`items[].instanceSchedulePolicy.timeZone`	`string` Specifies the time zone to be used in interpreting Schedule.schedule. The value of this field must be a time zone name from the tz database: https://wikipedia.org/wiki/Tz_database.
`items[].instanceSchedulePolicy.startTime`	`string` The start time of the schedule. The timestamp is an RFC3339 string.
`items[].instanceSchedulePolicy.expirationTime`	`string` The expiration time of the schedule. The timestamp is an RFC3339 string.
`items[].diskConsistencyGroupPolicy`	`object` Resource policy for disk consistency groups.
`items[].workloadPolicy`	`object`
`items[].workloadPolicy.type`	`enum`
`items[].workloadPolicy.maxTopologyDistance`	`enum`
`items[].workloadPolicy.acceleratorTopology`	`string`
`items[].kind`	`string` [Output Only] Type of the resource. Always `compute#resourcePolicies` for resource policies.
`items[].id`	`string (uint64 format)` [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`items[].creationTimestamp`	`string` [Output Only] Creation timestamp in RFC3339 text format.
`items[].selfLink`	`string` [Output Only] Server-defined fully-qualified URL for this resource.
`items[].region`	`string`
`items[].description`	`string`
`items[].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[].status`	`enum` [Output Only] The status of resource policy creation.
`items[].resourceStatus`	`object` [Output Only] The system status of the resource policy.
`items[].resourceStatus.instanceSchedulePolicy`	`object` [Output Only] Specifies a set of output values reffering to the instanceSchedulePolicy system status. This field should have the same name as corresponding policy field.
`items[].resourceStatus.instanceSchedulePolicy.nextRunStartTime`	`string` [Output Only] The next time the schedule is planned to run. The actual time might be slightly different. The timestamp is an RFC3339 string.
`items[].resourceStatus.instanceSchedulePolicy.lastRunStartTime`	`string` [Output Only] The last time the schedule successfully ran. The timestamp is an RFC3339 string.
`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.
`selfLink`	`string` [Output Only] Server-defined URL for this resource.
`etag`	`string`

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.resourcePolicies.list

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

Method: resourcePolicies.list Stay organized with collections Save and categorize content based on your preferences.