DescribeCostBudgetsSummary - Expenses and Costs - Alibaba Cloud Documentation Center

Queries a summary of cost budgets.

Operation description

This OpenAPI is in beta and available only to whitelisted users. Excessive calls may cause performance issues, such as response timeouts.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

bss:DescribeCostBudgetsSummary

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
BudgetName	string	No	The name of the budget. Supports fuzzy search.	全年预算
BudgetStatus	string	No	The status of the budget. If you do not specify this parameter, budgets in all statuses are returned. Valid values: notOverdue : The budget is not overdue. overdue : The budget is overdue.	notOverdue
BudgetType	string	No	The type of the budget. If you do not specify this parameter, budgets of all types are returned. Valid values: cost : Cost budget byquantity : Quantity-based budget asset : Usage and coverage budget	cost
NextToken	string	No	The token that is used to retrieve the next page of results. Set this parameter to the NextToken value that is returned in the response to the previous request. If you do not specify this parameter, the query starts from the first page.	eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6NH0=
MaxResults	integer	No	The maximum number of items to return. Valid values: 1 to 10. Default value: 10.	5

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The ID of the request.	3BFC23FE-A182-4D96-A1E4-7521B30B8E43
Success	boolean	Indicates whether the request was successful.	true
Code	string	The status code.	Success
Message	string	The error message.	Successful!
Data	object	The data that is returned.
NextToken	string	The token for the next page of results.	eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6NH0=
MaxResults	integer	The maximum number of entries returned on the current page.	5
TotalCount	integer	The total number of entries.	20
Items	array<object>	The list of items.
	object	The list of budgets.
BudgetName	string	The name of the budget.	全年预算
BudgetStatus	string	The status of the budget.	overdue
BudgetType	string	The type of the budget.	cost
Budget	object	Information about the budget. BudgetCycleType: The budget period. Valid values: daily, monthly, quarterly, and yearly. TotalBudgetAmount: The total budget amount. BudgetMemo: The notes for the budget.	{ "budgetCycleType": "monthly", "budgetMemo": "", "totalBudgetAmount": 220 }
CalculatedValues	object	Information about the estimate-to-actual comparison. ActualConsumeSum: The accumulated actual consumption. ActualAddForecastedAmount: The sum of the accumulated actual value and the predicted value. For a cost budget, this value represents the actual spending to date plus the forecasted spending until the budget period ends. ActualAndBudgetComparison: The comparison of the actual consumption to the budget. This value is calculated using the following formula: (Accumulated actual value / Total budget amount) × 100%.	{ "actualConsumeSum": 88.6, "actualAddForecastedAmount": 89.6, "actualAndBudgetComparison": "20.73%" }
ConsumePeriod	object	Information about the billing cycle. ConsumePeriodBegin: The start date of the budget. ConsumePeriodEnd: The end date of the budget.	{ "consumePeriodBegin": "2022-10", "consumePeriodEnd": "2022-11" }
HostId	string	The website.	cn

Examples

Success response

JSON format

{
  "RequestId": "3BFC23FE-A182-4D96-A1E4-7521B30B8E43",
  "Success": true,
  "Code": "Success",
  "Message": "Successful!",
  "Data": {
    "NextToken": "eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6NH0=",
    "MaxResults": 5,
    "TotalCount": 20,
    "Items": [
      {
        "BudgetName": "全年预算",
        "BudgetStatus": "overdue",
        "BudgetType": "cost",
        "Budget": {
          "budgetCycleType": "monthly",
          "budgetMemo": "",
          "totalBudgetAmount": 220
        },
        "CalculatedValues": {
          "actualConsumeSum": 88.6,
          "actualAddForecastedAmount": 89.6,
          "actualAndBudgetComparison": "20.73%"
        },
        "ConsumePeriod": {
          "consumePeriodBegin": "2022-10",
          "consumePeriodEnd": "2022-11"
        }
      }
    ],
    "HostId": "cn"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.