ListBudget - 查询预算列表--费用中心-火山引擎

文档中心

导航

ListBudget - 查询预算列表

最近更新时间：2025.10.17 15:11:15首次发布时间：2025.10.17 15:11:15

根据请求参数查询预算列表

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ListBudget	要执行的操作，取值：ListBudget。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
Status	Array of Integer	是	100	状态。枚举值：100 未开始，200 执行中，300 已过期，400 已失效
BudgetType	String	否	cost_budget	预算类型。cost_budget 成本预算
BudgetName	String	否	预算名称	预算名称
Limit	Integer	是	100	查询数量
Offset	Integer	是	0	查询偏移量
OrderBy	String	否	ratio	枚举值：ratio（按照预算使用比例排序）。不传默认按照创建时间排序。
OrderType	String	否	desc	排序类型。枚举值：desc（倒序）、asc（升序）。默认desc

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
BudgetList	Array of Object	[{ ActualAmount: "0", BudgetAmount: "100", BudgetEndTime: "2025-12", BudgetID: "bg7561495604304826668", BudgetName: "openapi-create", BudgetStartTime: "2025-10", BudgetType: "cost_budget", Period: "month", Ratio: "0", Status: 200 }]	预算列表信息
Total	Integer	1	预算总数量
Limit	Integer	10	查询数量
Offset	Integer	1	查询偏移量

请求示例

{
    BudgetName: "openapi-create",
    BudgetType: "cost_budget",
    Limit: 10,
    Offset: 0
}

返回示例

{
  Metadata: {
    RequestId: "20251016012003506CE4A493D88803676A",
    Action: "ListBudget",
    Version: "2022-01-01",
    Service: "billing",
    Region: "cn-beijing",
    HTTPCode: 200
  },
  BudgetList: [{
      ActualAmount: "0",
      BudgetAmount: "100",
      BudgetEndTime: "2025-12",
      BudgetID: "bg7561495604304826668",
      BudgetName: "openapi-create",
      BudgetStartTime: "2025-10",
      BudgetType: "cost_budget",
      Period: "month",
      Ratio: "0",
      Status: 200
    }],
  Limit: 10,
  Offset: 0,
  Total: 1
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
500	InternalServerError	The request has failed due to an unknown error.	系统错误，多次出现时请联系管理员