Filters an organization's assets and groups them by their specified properties.
HTTP request
The URLs use gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. The name of the parent to group the assets by. Its format is |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "filter": string, "groupBy": string, "compareDuration": string, "readTime": string, "pageToken": string, "pageSize": integer } |
Fields | |
---|---|
filter |
Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators Restrictions have the form
The supported operators are:
The supported value types are:
The following field and operator combinations are supported:
Usage: This should be milliseconds since epoch or an RFC3339 string. Examples:
Usage: This should be milliseconds since epoch or an RFC3339 string. Examples:
For example, Use a partial match on the empty string to filter based on a property existing: Use a negated partial match on the empty string to filter based on a property not existing: |
groupBy |
Required. Expression that defines what assets fields to use for grouping. The string value should follow SQL syntax: comma separated list of fields. For example: "securityCenterProperties.resource_project,securityCenterProperties.project". The following fields are supported when compareDuration is not set:
The following fields are supported when compareDuration is set:
|
compareDuration |
When compareDuration is set, the GroupResult's "stateChange" property is updated to indicate whether the asset was added, removed, or remained present during the compareDuration period of time that precedes the readTime. This is the time between (readTime - compareDuration) and readTime. The state change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible "stateChange" values when compareDuration is specified:
If compareDuration is not specified, then the only possible stateChange is "UNUSED", which will be the stateChange set for all assets present at readTime. If this field is set then A duration in seconds with up to nine fractional digits, ending with ' |
readTime |
Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
pageToken |
The value returned by the last |
pageSize |
The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. |
Response body
If successful, the response body contains an instance of GroupAssetsResponse
.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.