- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- IAM Permissions
- Examples
- Try it!
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 | |
---|---|
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. 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 For example, if you are filtering Compute Engine instances, you can exclude instances named 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
|
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. |
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. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
JSON representation | |
---|---|
{ "id": string, "items": [ { "scopeName": string, "resourcePolicies": [ { "id": string, "creationTimestamp": string, "selfLink": string, "region": string, "description": string, "name": string, "status": enum, "resourceStatus": { "instanceSchedulePolicy": { "nextRunStartTime": string, "lastRunStartTime": string } }, "kind": string, // Union field |
Fields | |
---|---|
id |
[Output Only] Unique identifier for the resource; defined by the server. |
items[] |
A list of ResourcePolicy resources. |
items[].scopeName |
Name of the scope containing this set of resourcePolicies. |
items[].resourcePolicies[] |
A list of resourcePolicies contained in this scope. |
items[].resourcePolicies[].id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
items[].resourcePolicies[].creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
items[].resourcePolicies[].selfLink |
[Output Only] Server-defined fully-qualified URL for this resource. |
items[].resourcePolicies[].region |
|
items[].resourcePolicies[].description |
|
items[].resourcePolicies[].name |
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 |
items[].resourcePolicies[].snapshotSchedulePolicy |
Resource policy for persistent disks for creating snapshots. |
items[].resourcePolicies[].snapshotSchedulePolicy.schedule |
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 |
|
items[].resourcePolicies[].snapshotSchedulePolicy.schedule.hourlySchedule.hoursInCycle |
Defines a schedule with units measured in hours. The value determines how many hours pass between the start of each cycle. |
items[].resourcePolicies[].snapshotSchedulePolicy.schedule.hourlySchedule.startTime |
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 |
[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. |
items[].resourcePolicies[].snapshotSchedulePolicy.schedule.dailySchedule |
|
items[].resourcePolicies[].snapshotSchedulePolicy.schedule.dailySchedule.daysInCycle |
Defines a schedule with units measured in months. The value determines how many months pass between the start of each cycle. |
items[].resourcePolicies[].snapshotSchedulePolicy.schedule.dailySchedule.startTime |
instances.start time of the window. This must be in UTC format that resolves to one of |
items[].resourcePolicies[].snapshotSchedulePolicy.schedule.dailySchedule.duration |
[Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario. |
items[].resourcePolicies[].snapshotSchedulePolicy.schedule.weeklySchedule |
|
items[].resourcePolicies[].snapshotSchedulePolicy.schedule.weeklySchedule.dayOfWeeks[] |
Up to 7 intervals/windows, one for each day of the week. |
items[].resourcePolicies[].snapshotSchedulePolicy.schedule.weeklySchedule.dayOfWeeks[].day |
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[].resourcePolicies[].snapshotSchedulePolicy.schedule.weeklySchedule.dayOfWeeks[].startTime |
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 |
[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. |
items[].resourcePolicies[].snapshotSchedulePolicy.retentionPolicy |
Retention policy applied to snapshots created by this resource policy. |
items[].resourcePolicies[].snapshotSchedulePolicy.retentionPolicy.maxRetentionDays |
Maximum age of the snapshot that is allowed to be kept. |
items[].resourcePolicies[].snapshotSchedulePolicy.retentionPolicy.onSourceDiskDelete |
Specifies the behavior to apply to scheduled snapshots when the source disk is deleted. |
items[].resourcePolicies[].snapshotSchedulePolicy.snapshotProperties |
Properties with which snapshots are created such as labels, encryption keys. |
items[].resourcePolicies[].snapshotSchedulePolicy.snapshotProperties.labels |
Labels to apply to scheduled snapshots. These can be later modified by the An object containing a list of |
items[].resourcePolicies[].snapshotSchedulePolicy.snapshotProperties.storageLocations[] |
Cloud Storage bucket storage location of the auto snapshot (regional or multi-regional). |
items[].resourcePolicies[].snapshotSchedulePolicy.snapshotProperties.guestFlush |
Indication to perform a 'guest aware' snapshot. |
items[].resourcePolicies[].snapshotSchedulePolicy.snapshotProperties.chainName |
Chain name that the snapshot is created in. |
items[].resourcePolicies[].groupPlacementPolicy |
Resource policy for instances for placement configuration. |
items[].resourcePolicies[].groupPlacementPolicy.vmCount |
Number of vms in this placement group |
items[].resourcePolicies[].groupPlacementPolicy.availabilityDomainCount |
The number of availability domains instances will be spread across. If two instances are in different availability domain, they will not be put in the same low latency network |
items[].resourcePolicies[].groupPlacementPolicy.collocation |
Specifies network collocation |
items[].resourcePolicies[].instanceSchedulePolicy |
Resource policy for scheduling instance operations. |
items[].resourcePolicies[].instanceSchedulePolicy.vmStartSchedule |
Specifies the schedule for starting instances. |
items[].resourcePolicies[].instanceSchedulePolicy.vmStartSchedule.schedule |
Specifies the frequency for the operation, using the unix-cron format. |
items[].resourcePolicies[].instanceSchedulePolicy.vmStopSchedule |
Specifies the schedule for stopping instances. |
items[].resourcePolicies[].instanceSchedulePolicy.vmStopSchedule.schedule |
Specifies the frequency for the operation, using the unix-cron format. |
items[].resourcePolicies[].instanceSchedulePolicy.timeZone |
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: http://en.wikipedia.org/wiki/Tz_database. |
items[].resourcePolicies[].instanceSchedulePolicy.startTime |
The start time of the schedule. The timestamp is an RFC3339 string. |
items[].resourcePolicies[].instanceSchedulePolicy.expirationTime |
The expiration time of the schedule. The timestamp is an RFC3339 string. |
items[].resourcePolicies[].status |
[Output Only] The status of resource policy creation. |
items[].resourcePolicies[].resourceStatus |
[Output Only] The system status of the resource policy. |
items[].resourcePolicies[].resourceStatus.instanceSchedulePolicy |
[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[].resourcePolicies[].resourceStatus.instanceSchedulePolicy.nextRunStartTime |
[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[].resourcePolicies[].resourceStatus.instanceSchedulePolicy.lastRunStartTime |
[Output Only] The last time the schedule successfully ran. The timestamp is an RFC3339 string. |
items[].resourcePolicies[].kind |
[Output Only] Type of the resource. Always |
items[].warning |
Informational warning which replaces the list of resourcePolicies 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. |
etag |
|
unreachables[] |
[Output Only] Unreachable resources. |
kind |
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 IAM permissions:
compute.resourcePolicies.list
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.