Configure idle reservation recommendations

Preview

This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of theService Specific Terms. Pre-GA products and features are available "as is" and might have limited support. For more information, see thelaunch stage descriptions.

This page describes how to view and modify the configuration of your idle,on-demand reservation recommendations. You might want to modify theconfiguration to increase the number of recommendations that you receive, orto get fewer recommendations to delete reservations that you plan to use.

Before you begin

Configure your recommendations

To configure your idle reservation recommendations, do the following:

  1. Get the current configuration to obtainthe JSON file of the configuration.
  2. Edit the configuration file in JSON format.
  3. Upload the new configuration fileto apply the changes.

Get the current configuration

You can obtain the current configuration for idle reservation recommendationsfor your project by using the Google Cloud CLI or REST.

Permissions required for this task

To perform this task, you must have the followingpermissions:

  • recommender.computeIdleResourceRecommendations.get on the project.

Complete this task using one of the following methods.

gcloud

To get the current configuration parameters, use thegcloud recommender recommender-config describe commandand usegoogle.compute.IdleResourceRecommender as theRecommender ID:

gcloud recommender recommender-config describe google.compute.IdleResourceRecommender \  --location=ZONE --billing-account=BILLING_ACCOUNT_ID

ReplaceZONE with the zone for which you want to getthe current configuration.

For example:

gcloud recommender recommender-config describe google.compute.IdleResourceRecommender \  --location=us-central1-c --billing-account=my-billing-account-id

The command returns the recommender configuration, including the modifiablesubfieldparams.idle_reservation_lookback_period.

{  "name": "projects/PROJECT_ID/locations/ZONE/recommenders/google.compute.IdleResourceRecommender/config",  "recommenderGenerationConfig": {    "params": {      "idle_reservation_lookback_period": "P7D"    }  },  "etag": "\"2f3c9b65cda6a4ba\"",  "updateTime": "2024-06-03T04:41:15.330351Z"}

REST

To retrieve the current configuration, use therecommenders.getConfigmethod and specifygoogle.compute.IdleResourceRecommender as theRecommender ID:

GET https://recommender.googleapis.com/v1/projects/PROJECT_ID/locations/ZONE/recommenders/google.compute.IdleResourceRecommender/config

ReplaceZONE with the zone that contains your project.

From the command line, execute the following command to get the recommenderconfiguration for a project:

PROJECT_ID=PROJECT_IDZONE=ZONEcurl -X GET -H "Authorization: Bearer $(gcloud auth print-access-token)" \-H "x-goog-user-project: ${PROJECT_ID}" \https://recommender.googleapis.com/v1/projects/$PROJECT_ID/locations/$ZONE/recommenders/google.compute.IdleResourceRecommender/config

The command returns the recommender configuration, including the subfieldthat you can modify:params.idle_reservation_lookback_period.

{  "name": "projects/PROJECT_ID/locations/ZONE/recommenders/google.compute.IdleResourceRecommender/config",  "recommenderGenerationConfig": {    "params": {      "idle_reservation_lookback_period": "P7D"    }  },  "etag": "\"2f3c9b65cda6a4ba\"",  "updateTime": "2024-06-03T04:41:15.330351Z"}
Note: When you submit the new configuration, remove theupdateTimeparameter.

Update the configuration for a project

To update the configuration of your idle reservation recommendations, modify thevalue foridle_reservation_lookback_period and upload the new configuration for your project.

You can set the observation period to a value of 7 days up to 30 days, usinga string beginning withP, then an integer for the number of days (7 minimumand30 maximum), followed byD, for example:

After you upload the new configuration, it takes approximately 48 hours for itto take effect. Until that time, any generated recommendations use the previousconfiguration.

Permissions required for this task

To perform this task, you must have the followingpermissions:

  • recommender.computeIdleResourceRecommenderConfig.get on the project to view the configuration.
  • recommender.computeIdleResourceRecommenderConfig.update on the project to modify the configuration.

gcloud

To update the configuration parameters, use thegcloud recommender recommender-config update commandand usegoogle.compute.IdleResourceRecommender as theRecommender ID:

gcloud recommender recommender-config update google.compute.IdleResourceRecommender\  --location=ZONE \  --config-file=CONFIG_FILE_PATH \  --etag=ETAG \  --billing-account=BILLING_ACCOUNT_ID

Replace the following:

  • ZONE: the zone for which you want to obtain thecurrent configuration
  • CONFIG_FILE_PATH: the path to the JSON file withthe current configuration
  • ETAG: the etag value of the current configuration
  • BILLING_ACCOUNT_ID: the ID of the billing account

In your configuration file, specify only therecommenderGenerationConfigobject with the updated configuration parameters. For example, to specifyan observation period of 21 days, use the following configuration file:

{  "params": {    "idle_reservation_lookback_period": "P21D"  }}

If the command is successful, it returns a response body similar to thefollowing, showing the new configuration with the parameters you justmodified.

{  "name": "projects/PROJECT_ID/locations/ZONE/recommenders/google.compute.IdleResourceRecommender/config",  "recommenderGenerationConfig": {    "params": {      "idle_reservation_lookback_period": "P21D"    }  },  "etag": "\"1245f9435cd01ea8\"",  "updateTime": "2024-06-03T05:00:05Z"}
Note: theetag value changes from the previous configuration. Youmust use the new value if you update the configuration again.

REST

To update the configuration, make aPATCH request to therecommenders.updateConfigmethod and specifygoogle.compute.IdleResourceRecommender as theRecommender ID:

PATCH https://recommender.googleapis.com/v1/projects/PROJECT_ID/locations/ZONE/recommenders/google.compute.IdleResourceRecommender/config{  "name": "projects/PROJECT_ID/locations/ZONE/recommenders/google.compute.IdleResourceRecommender/config",  "recommenderGenerationConfig": {    "params": {      "idle_reservation_lookback_period": "P21D"    }  },  "etag": "\"2f3c9b65cda6a4ba\""}

Replace the following:

  • PROJECT_ID: the ID of the project for which youwant to modify the recommender configuration.
  • ZONE: the zone that contains your project.

Save the request body in a file, for exampleconfig.json.You can then reference the file when you update the recommender configurationfor your project, using a command similar to the following:

curl -X PATCH \-H "Authorization: Bearer $(gcloud auth print-access-token)" \-H "Content-Type: application/json; charset=utf-8" \-H "x-goog-user-project: ${PROJECT_ID}" \-d @config.json \https://recommender.googleapis.com/v1/projects/$PROJECT_ID/locations/$ZONE/recommenders/google.compute.IdleResourceRecommender/config

ThePOST command returns a response body similar to the following, showingthe new configuration with the parameters you just modified.

{  "name": "projects/PROJECT_ID/locations/ZONE/recommenders/google.compute.IdleResourceRecommender/config",  "recommenderGenerationConfig": {    "params": {      "idle_reservation_lookback_period": "P21D"    }  },  "etag": "\"1245f9435cd01ea8\"",  "updateTime": "2024-06-03T05:00:05Z"}
Note: theetag value changes from the previous configuration. Youmust use the new value if you update the configuration again.

What's next

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-15 UTC.