Method: projects.locations.insightTypes.insights.list

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

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path 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/

Query 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"

Request body

The request body must be empty.

Response body

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

Response to the insights.list method.

JSON representation
{
  "insights": [
    {
      object (Insight)
    }
  ],
  "nextPageToken": string
}
Fields
insights[]

object (Insight)

The set of insights for the parent resource.

nextPageToken

string

A token that can be used to request the next page of results. This field is empty if there are no additional results.

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 Cloud IAM permissions on the parent resource, depending on the resource type:

  • recommender.computeDiskIdleResourceInsights.list
  • recommender.computeFirewallInsights.list
  • recommender.iamPolicyInsights.list
  • recommender.iamServiceAccountInsights.list

For more information, see the Cloud IAM Documentation.