You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: The actual cost for this entry. Present only when `actual=true` is requested.
12869
+
format: double
12870
+
nullable: true
12871
+
type: number
12872
+
amount:
12873
+
description: The budgeted amount for this entry.
12874
+
format: double
12875
+
nullable: true
12876
+
type: number
12877
+
custom_forecast:
12878
+
description: |-
12879
+
The custom forecast override for this entry. `null` when `forecast=true` is requested but no custom forecast has been set for this entry's month. A numeric value, including `0`, indicates an explicit custom forecast override. Omitted when `forecast=false` or the feature is not available for the organization.
12880
+
format: double
12881
+
nullable: true
12882
+
type: number
12883
+
forecast:
12884
+
description: The final forecast for this entry, with any custom forecast override applied. Present only when `forecast=true` is requested.
12885
+
format: double
12886
+
nullable: true
12887
+
type: number
12888
+
ootb_forecast:
12889
+
description: The out-of-the-box ML forecast for this entry, before custom overrides. Present only when `forecast=true` is requested.
description: A tag filter used to scope a budget entry to specific resource tags.
12802
12896
properties:
@@ -116220,10 +116314,36 @@ paths:
116220
116314
tags:
116221
116315
- Cloud Cost Management
116222
116316
get:
116223
-
description: Get a budget
116317
+
description: Get a budget by ID. Pass `actual=true` or `forecast=true` to include cost data in the response. Use `start` and `end` (millisecond epochs, both required) to set the cost window. When `forecast=true`, each entry also includes `ootb_forecast` (the ML forecast before overrides) and `custom_forecast` (`null` if no override is set, a number if one is).
116224
116318
operationId: GetBudget
116225
116319
parameters:
116226
116320
- $ref: "#/components/parameters/BudgetID"
116321
+
- description: When `true`, includes actual cost data in the response.
116322
+
in: query
116323
+
name: actual
116324
+
required: false
116325
+
schema:
116326
+
type: boolean
116327
+
- description: When `true`, includes forecast cost data in the response, including `ootb_forecast` and `custom_forecast` per entry.
116328
+
in: query
116329
+
name: forecast
116330
+
required: false
116331
+
schema:
116332
+
type: boolean
116333
+
- description: Start of the cost window in milliseconds since epoch. Must be used together with `end`.
116334
+
in: query
116335
+
name: start
116336
+
required: false
116337
+
schema:
116338
+
format: int64
116339
+
type: integer
116340
+
- description: End of the cost window in milliseconds since epoch. Must be used together with `start`.
Get a budget by ID. Pass ``actual=true`` or ``forecast=true`` to include cost data in the response. Use ``start`` and ``end`` (millisecond epochs, both required) to set the cost window. When ``forecast=true`` , each entry also includes ``ootb_forecast`` (the ML forecast before overrides) and ``custom_forecast`` ( ``null`` if no override is set, a number if one is).
2162
2187
2163
2188
:param budget_id: Budget id.
2164
2189
:type budget_id: str
2190
+
:param actual: When ``true`` , includes actual cost data in the response.
2191
+
:type actual: bool, optional
2192
+
:param forecast: When ``true`` , includes forecast cost data in the response, including ``ootb_forecast`` and ``custom_forecast`` per entry.
2193
+
:type forecast: bool, optional
2194
+
:param start: Start of the cost window in milliseconds since epoch. Must be used together with ``end``.
2195
+
:type start: int, optional
2196
+
:param end: End of the cost window in milliseconds since epoch. Must be used together with ``start``.
0 commit comments