Method: projects.locations.forecasts.query

Returns a list of the forecasts that are in the parent parameter and match your specified filters.

HTTP request

POST https://capacityplanner.googleapis.com/v1beta/{parent=projects/*/locations/*}/forecasts:query

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The compute engine resource and location for the time series values to return. The format is:

projects/{project}/locations/{location} or organizations/{organization}/locations/{location} or folders/{folder}/locations/{location}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "machineFamily": string,
  "machineShape": {
    object (MachineShape)
  },
  "diskType": string,
  "gpuType": string,
  "tpuType": string,
  "cloudResourceType": string,
  "forecastType": enum (ForecastType),
  "predictionInterval": enum (PredictionInterval),
  "aggregationMethod": enum (AggregationMethod)
}
Fields
machineFamily

string

The machine family to use to select the Forecast values to return. Possible values include "n1", and "n2d". Empty machineFamily will return results matching all machine families.
machineShape

object (MachineShape)

Optional. The machine shape for the time series values to return.
diskType

string

Optional. The diskType for the Forecast values to return with request persistent-disk cloudResourceType. Empty diskType will return results matching all disk types.
gpuType

string

Optional. The GPU type for the Forecast values to return. Sample values are "nvidia-tesla-t4", and "nvidia-tesla-a100". See https://cloud.google.com/compute/docs/gpus for a list. Empty gpuType will return results matching all GPUs.
tpuType

string

Optional. The TPU type for the Forecast values to return. Empty tpuType will return results matching all TPUs.
cloudResourceType

string

The resource for the Forecast values to return. Possible values include "gce-vcpus", "gce-ram", "gce-local-ssd", "gce-persistent-disk", "gce-gpu" and "gce-tpu". Empty cloudResourceType will return results matching all resources.
forecastType

enum (ForecastType)

The type of forecast to use to select the Forecast values to return. FORECAST_TYPE_UNSPECIFIED will return results matching all the forecast types.
predictionInterval

enum (PredictionInterval)

The prediction interval to use to select the Forecast values to return. PREDICTION_INTERVAL_UNSPECIFIED will return results matching all prediction intervals.
aggregationMethod

enum (AggregationMethod)

Aggregation Method of the historical usage for which the forecast is generated

Response body

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

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/devstorage.full_control

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • capacityplanner.forecasts.list

For more information, see the IAM documentation.