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=organizations/*/locations/*}/forecasts:query
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
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 ( |
Fields | |
---|---|
machineFamily |
The machine family to use to select the |
machineShape |
Optional. The machine shape for the time series values to return. |
diskType |
Optional. The diskType for the |
gpuType |
Optional. The GPU type for the |
tpuType |
Optional. The TPU type for the |
cloudResourceType |
The resource for the |
forecastType |
The type of forecast to use to select the |
predictionInterval |
The prediction interval to use to select the |
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.