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.
13484
+
format: double
13485
+
nullable: true
13486
+
type: number
13487
+
amount:
13488
+
description: The budgeted amount for this entry.
13489
+
format: double
13490
+
nullable: true
13491
+
type: number
13492
+
custom_forecast:
13493
+
description: |-
13494
+
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.
13495
+
format: double
13496
+
nullable: true
13497
+
type: number
13498
+
forecast:
13499
+
description: The final forecast for this entry, with any custom forecast override applied. Present only when `forecast=true` is requested.
13500
+
format: double
13501
+
nullable: true
13502
+
type: number
13503
+
ootb_forecast:
13504
+
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.
13417
13511
properties:
@@ -124497,10 +124591,36 @@ paths:
124497
124591
tags:
124498
124592
- Cloud Cost Management
124499
124593
get:
124500
-
description: Get a budget
124594
+
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).
124501
124595
operationId: GetBudget
124502
124596
parameters:
124503
124597
- $ref: "#/components/parameters/BudgetID"
124598
+
- description: When `true`, includes actual cost data in the response.
124599
+
in: query
124600
+
name: actual
124601
+
required: false
124602
+
schema:
124603
+
type: boolean
124604
+
- description: When `true`, includes forecast cost data in the response, including `ootb_forecast` and `custom_forecast` per entry.
124605
+
in: query
124606
+
name: forecast
124607
+
required: false
124608
+
schema:
124609
+
type: boolean
124610
+
- description: Start of the cost window in milliseconds since epoch. Must be used together with `end`.
124611
+
in: query
124612
+
name: start
124613
+
required: false
124614
+
schema:
124615
+
format: int64
124616
+
type: integer
124617
+
- 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).
1042
1042
#
1043
1043
# @param budget_id [String] Budget id.
1044
1044
# @param opts [Hash] the optional parameters
1045
+
# @option opts [Boolean] :actual When `true`, includes actual cost data in the response.
1046
+
# @option opts [Boolean] :forecast When `true`, includes forecast cost data in the response, including `ootb_forecast` and `custom_forecast` per entry.
1047
+
# @option opts [Integer] :start Start of the cost window in milliseconds since epoch. Must be used together with `end`.
1048
+
# @option opts [Integer] :_end End of the cost window in milliseconds since epoch. Must be used together with `start`.
1045
1049
# @return [Array<(BudgetWithEntries, Integer, Hash)>] BudgetWithEntries data, response status code and response headers
0 commit comments