projects

Changed on

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

get/v1/{+parent}/recommendations

Request

  • Base URL: https://recommender.googleapis.com
  • URL: https://recommender.googleapis.com/v1/{+parent}/recommendations
  • Auth: OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/cloud-platform) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/cloud-platform)

Path parameters

parentstring required

Required. The container resource on which to execute the request. Acceptable formats: * projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] * projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] * billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] * folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] * organizations/[ORGANIZATION_ID]/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

filterstring

Filter expression to restrict the recommendations returned. Supported filter fields: * state_info.state * recommenderSubtype * priority * targetResources Examples: * stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED * recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE * priority = P1 OR priority = P2 * targetResources : //compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance-1 * stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2) The max allowed filter length is 500 characters. (These expressions are based on the filter language described at https://google.aip.dev/160)

pageSizeinteger

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.

pageTokenstring

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

Response

Successful response

Changes

  • f036637ff57eRevision changes
    • breaking

      removed the media type */* for the response with the status

    • info

      api operation id recommender.billingAccounts.locations.recommenders.recommendations.list removed and replaced with recommender.projects.locations.recommenders.recommendations.list

    • info

      api tag projects added

    • info

      api tag billingAccounts removed