Method: projects.locations.insightTypes.insights.list

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

Lists insights for a Cloud project. Requires the recommender.*.list IAM permission for the specified insight type.

HTTP request

GET https://recommender.googleapis.com/v1/{parent=projects/*/locations/*/insightTypes/*}/insights

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`parent`	`string` Required. The container resource on which to execute the request. Acceptable formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.)

parent

string

Required. The container resource on which to execute the request. Acceptable formats:

1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]",

LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.)

Query parameters

Parameters

Parameters
`pageSize`	`integer` Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.
`pageToken`	`string` Optional. If present, retrieves the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters must be identical to those in the previous call.
`filter`	`string` Optional. Filter expression to restrict the insights returned. Supported filter fields: state Eg: `state:"DISMISSED" or state:"ACTIVE"

pageSize

integer

Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.

pageToken

string

Optional. If present, retrieves the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters must be identical to those in the previous call.

filter

string

Optional. Filter expression to restrict the insights returned. Supported filter fields: state Eg: `state:"DISMISSED" or state:"ACTIVE"

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ListInsightsResponse.

Authorization Scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires one of the following IAM permissions on the parent resource, depending on the resource type:

recommender.commitmentUtilizationInsights.list
recommender.computeAddressIdleResourceInsights.list
recommender.computeDiskIdleResourceInsights.list
recommender.computeFirewallInsights.list
recommender.computeImageIdleResourceInsights.list
recommender.iamPolicyInsights.list
recommender.iamServiceAccountInsights.list

For more information, see the IAM documentation.