Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.
Scopes
You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.
If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform.
You can set the scope for this method like this: recommender1-beta1 --scope <scope> folders locations-recommenders-recommendations-list ...
Required Scalar Argument
- <parent> (string)
- 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.
- Required. The container resource on which to execute the request. Acceptable formats: *
Optional Output Flags
The method's return value a JSON encoded structure, which will be written to standard output by default.
- -o out
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
-
to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
Optional Method Properties
You may set the following properties to further configure the call. Please note that -p
is followed by one
or more key-value-pairs, and is called like this -p k1=v1 k2=v2
even though the listing below repeats the
-p
for completeness.
-
-p filter=string
- 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)
- Filter expression to restrict the recommendations returned. Supported filter fields: *
-
-p page-size=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.
-
-p page-token=string
- Optional. If present, retrieves the next batch of results from the preceding call to this method.
page_token
must be the value ofnext_page_token
from the previous response. The values of other method parameters must be identical to those in the previous call.
- Optional. If present, retrieves the next batch of results from the preceding call to this method.
Optional General Properties
The following properties can configure any call, and are not specific to this method.
-
-p $-xgafv=string
- V1 error format.
-
-p access-token=string
- OAuth access token.
-
-p alt=string
- Data format for response.
-
-p callback=string
- JSONP
-
-p fields=string
- Selector specifying which fields to include in a partial response.
-
-p key=string
- API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
-
-p oauth-token=string
- OAuth 2.0 token for the current user.
-
-p pretty-print=boolean
- Returns response with indentations and line breaks.
-
-p quota-user=string
- Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
-
-p upload-type=string
- Legacy upload protocol for media (e.g. "media", "multipart").
-
-p upload-protocol=string
- Upload protocol for media (e.g. "raw", "multipart").