官网参考文档:https://www.volcengine.com/docs/6269/1165274
想要快速发起接口请求,可在OpenApi中心,选择需要调用的接口并输入请求的过滤参数,就可在SDK实例下生成可执行的代码。
SDK 代码主要由两部分组成,分别是业务实现代码(一般位于 Service 目录下)和调用样例代码(一般位于 Example 目录下)。用户可以首先根据 README.md 文件中的介绍下载安装我们提供的 SDK,然后仿照我们提供的调用样例代码编写代码,调用火山引擎费用中心 - OpenAPI 接口。
火山引擎:https://github.com/volcengine
- ListBillOverviewByCategory - 查询账单总览-账号汇总信息
- ListBillOverviewByProd - 分页查询账单总览-产品汇总信息
- ListBillDetail - 分页查询账单明细
- ListSplitBillDetail - 分页查询分账账单
- ListAmortizedCostBillDetail - 查询成本账单明细
- ListAmortizedCostBillMonthly - 查询成本账单总览
- ListAmortizedCostBillDaily - 查询成本账单按天
- ListBillOverviewByCategory- 查询账单总览-账号汇总信息
- ListBillOverviewByProd- 分页查询账单总览-产品汇总信息
- ListBillDetail- 分页查询账单明细
- ListAmortizedCostBillDaily - 查询成本账单按天
接口的限流情况为单账号 5 QPS,1s可以查询300次,能查到1500条数据。超过限流阈值请求会直接失败,需要考虑限流策略
账单后端没有对权限做额外控制,只要能拿到AK、SK来访问open-api,就能看到跟控制台一样的结果。主账号可以通过iam来控制子账号能否查询分账账单,如果子账号有查看分账账单的权限,能拿到AK、SK就可以查到所有的分账账单,没有更细粒度的控制。
接口查询的结果本身不存在按时间排序的逻辑,可以在接口请求中增加排序和过滤条件。需要注意的是,如果要按交易时间排序,只能使用按天查询的接口,查询明细接口可以获取到小时的数据,但是不支持排序。
Q8:账单中心openapi调用接口数据延迟时间是多久
通过openap调用账单接口查询到的数据与控制台和后台费用中心查询的数据是一致的,不存在延迟的说法。
查看消费总额可以调用ListBillDetail接口查询账单明细,调用时参数GroupPeriod传1,ExpenseDate传与账期相同的具体日期,就可以获取到按天的账单明细查询,最后最需要查询的金额字段进行汇总即可。
Q10:通过ListBillOverviewByCategory接口查询当月消费总额,返回的数据有重复
ListBillOverviewByCategory接口返回的数据包括一条合计的数据和按账号的消费、退款等数据,可以通过BillCategoryParent字段来查看,如果要看当月消费总额看BillCategoryParent=“合计”对应的金额就行。
Q11:请求结果中Total返回-1,怎么获取账单数
接口返回Total为-1,想要查询账单数量需要增加查询条件:NeedRecordNum=1(1:表示需要; 0:表示不需要;默认为0---传0返回-1;传1返回实际数据数量
- Offset参数值设置大于账单数量值,会导致查询结果为空,可以对比查看参数Offset和Total的数量。
- 请求openapi时需要注意国内外域名不一致,通过官网下载账单SDK默认走国内域名,bp请求时需要检查请求是否有误。国内域名:open.volcengineapi.com 国外域名:open.byteplusapi.com。
- 成本账单、分账账单接口查不到数据,请检查控制台是否开通相关账单,成本账单和分账账单是开通型功能,需要用户手动在控制台开通菜单。成本账单开通后会自动生成当月的成本账单数据,第二天下午可见,同时支持历史成本账单回溯;分账账单开通后当月的分账账单数据会自动生成,历史月份无法回溯。
- 查询账单明细或分账账单明细时,若接口返回的字段值为空的情况,可以在账单页面查看确认是否一致,若不一致可能是页面数据查询的是计费项+明细维度,检查接口GroupTerm和GroupPeriod字段传参是否准确。
- 账单明细号字段在账单明细或分账账单明细下明细维度下才有值,账期维度和按天维度无法聚合。
- 项目、标签等字段,在账单明细和分账账单明细中有值,但在接口查询中没有值,需要注意查询维度是否与页面一致,明细维度下值不一样时,聚合到账期维度或按天维度下值为空 。
- offset为偏移量,需要批量捞取数据时需要对offset进行赋值,检查offset赋值是否正确。一次获取的数据量最多为300条,当limit=300时,可以设置offset+=300。
- 检查参数ignore_zero =1时表示忽略0元账单,即折后价为0,应付金额为0的账单会被忽略。若需要查询折后价、应付金额为0的账单,应设置ignore_zero=0。
查询账单明细的项目标签出现为空的情况,可能是查询到了项目标签为空的数据,可以在控制台账单管理查询。当账号下明细数据量过大时,可以增加入参,将数据范围缩小,查看结果是否与控制台一致,也可以增加查询范围,查询尽可能多的数据,去找到预期的账单。
账单SDK会根据新功能的优化进行迭代,存在新增账单字段等情况,可在官网下载最新版SDK进行调用
https://www.volcengine.com/docs/6269/1165274?lang=zh
或在接口调试页面可直接查看当前所用语言的【SDK信息】,根据SDK安装命令升级到最新版本。
https://api.volcengine.com/api-explorer/?