调用DescribeCostBudgetsSummary查询成本管理预算概要信息_阿里云交易和账单管理API(BOA)-阿里云帮助中心

查询用户 “成本管理-预算”的概要信息。

接口说明

本 OpenAPI 灰度中，仅对部分白名单用户开放，调用过多时不排除出现响应超时等性能问题。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
BudgetName	string	否	预算名称。模糊匹配	全年预算
BudgetStatus	string	否	预算状态，枚举值：overdue（已过期）,notOverdue（未过期）。不填写则默认取全部	notOverdue
BudgetType	string	否	预算类型。枚举值：cost(费用预算), byquantity（按量编制预算）, asset（使用率及覆盖率预算）。不填写则默认取全部	cost
NextToken	string	否	当前调用开始读取的位置，参数值必须为空或者使用返回结果中的 NextToken 设值，否则会报错，空则代表从头开始读取。默认：空	eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6NH0=
MaxResults	integer	否	读取的最大数据记录数量。默认值：10，最大值：10，最小值：1。	5

返回参数

名称	类型	描述	示例值
	object	BssResult
RequestId	string	请求 ID。	3BFC23FE-A182-4D96-A1E4-7521B30B8E43
Success	boolean	是否成功。	true
Code	string	状态码。	Success
Message	string	错误信息。	Successful!
Data	object	返回数据。
NextToken	string	下页 token	eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6NH0=
MaxResults	integer	本次请求所返回的最大记录条数。	5
TotalCount	integer	总记录数。	20
Items	array<object>	列表信息。
	object	预算列表
BudgetName	string	预算名称。	全年预算
BudgetStatus	string	预算状态	overdue
BudgetType	string	预算类型。	cost
Budget	object	预算相关信息，其中： BudgetCycleType 是滚动周期，枚举值：daily（日），monthly（月），quarterly（季），yearly(年)； TotalBudgetAmount 是预算总额； BudgetMemo 是预算备注。	{ "budgetCycleType": "monthly", "budgetMemo": "", "totalBudgetAmount": 220 }
CalculatedValues	object	预实分析相关信息，其中： ActualConsumeSum 是累计实际值； ActualAddForecastedAmount 是累计实际与预测之和。当预算类型为费用预算时，累计实际与预测之和为从预算开始日期至当前日期的实际发生额加上从当前日期至预算截止日期的预测值。若当前日期至预算截止日期超过一年，则不会包含超过一年的预测金额部分；当预算类型为使用率及覆盖率预算时，累计实际与预测之和为从预算开始日期至预算截止日期的使用率或覆盖率，不含超过一年的预测部分。 ActualAndBudgetComparison 是预实对比，累计实际值/预算总额*100%；	{ "actualConsumeSum": 88.6, "actualAddForecastedAmount": 89.6, "actualAndBudgetComparison": "20.73%" }
ConsumePeriod	object	账期相关信息。其中： ConsumePeriodBegin 是预算起始日期； ConsumePeriodEnd 是预算截止日期。	{ "consumePeriodBegin": "2022-10", "consumePeriodEnd": "2022-11" }
HostId	string	站点名称	cn

示例

正常返回示例

JSON格式

{
  "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"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2022-12-06	新增 OpenAPI	查看变更详情