Method: projects.locations.recommenders.recommendations.list

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

Lists recommendations for a Cloud project. Requires the recommender.*.list IAM permission for the specified recommender.

HTTP request

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

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]/recommenders/[RECOMMENDER_ID]", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ RECOMMENDER_ID refers to supported recommenders: https://cloud.google.com/recommender/docs/recommenders.

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 Filter expression to restrict the recommendations returned. Supported filter fields: stateInfo.state Eg: `stateInfo.state:"DISMISSED" or stateInfo.state:"FAILED"

Request body

The request body must be empty.

Response body

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

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.usageCommitmentRecommendations.list
• recommender.computeAddressIdleResourceRecommendations.list
• recommender.computeDiskIdleResourceRecommendations.list
• recommender.computeImageIdleResourceRecommendations.list
• recommender.computeInstanceGroupManagerMachineTypeRecommendations.list
• recommender.computeInstanceIdleResourceRecommendations.list
• recommender.computeInstanceMachineTypeRecommendations.list
• recommender.iamPolicyRecommendations.list

For more information, see the IAM documentation.