You need to enable JavaScript to run this app.
导航

ListBillDetail - 分页查询账单明细

最近更新时间2024.04.02 19:49:58

首次发布时间2023.12.06 17:34:21

分页查询账单明细

调试

请求参数

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

注意

为了提升查询效率和成功率,您可使用账单日期"ExpenseDate"指定获取某日数据、或使用统计周期"GroupPeriod"获取按日/按月聚合口径数据;

参数
类型
是否必填
示例值
描述
Action
String

ListBillDetail

要执行的操作,取值:ListBillDetail

Version
String

2022-01-01

API的版本,取值:2022-01-01

Product
Array of String

[ECS]

产品名称,默认不选为全部

BillingMode
Array of String

[1]

计费模式:1:包年包月;2:按量计费;3:合同计费;4:履约计费;默认不选为全部

BillCategory
Array of String

[consume-use]

账单类型:consume-use:消费-使用;consume-new:消费-新购;consume-renew:消费-续费;consume-formalize:消费-转正;consume-modify:消费-更配;consume-trial:消费-试用;refund-terminate:退款-退订;refund-modify:退款-更配;transfer-manual:调账-人工;transfer-system:调账-系统;默认不选为全部

Offset
Integer

10

偏移量

Limit
Integer

10

数量:[1-300]

BillPeriod
String

2023-08

账期:格式为YYYY-MM;仅支持单月查询;最多24个月;最早只能查询2022-01(新版账单的时间)

ExpenseDate
String

2023-03-15

账单日期,在GroupPeriod=1时支持账单日期传参,必须与账期在同一月份

GroupTerm
Integer

0

统计项:0:计费项;1:实例;2:产品;3:账号;

GroupPeriod
Integer

0

统计周期:0:账期;1:按天;2:明细;

InstanceNo
String

i-ycjlq77tdg8rx6ib4v1s

实例id:默认不选为全部;

IgnoreZero
Integer

1

是否忽略折后价为0的数据:0:不忽略;1忽略;默认为不忽略;

NeedRecordNum
Integer

1

是否需要访问列表的总记录数:用于前端分页;1:表示需要; 0:表示不需要;默认为不需要

返回参数

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

参数
类型
示例值
描述
List
Array of BillDetail

账单明细列表

Total
Integer

100

总数

Limit
Integer

100

步长

Offset
Integer

0

偏移量

请求示例

curl --location --request POST 'https://open.volcengineapi.com?Action= ListBillDetail&Version=2022-01-01' \
--header 'AccessKey: AKLTZm*****' \
--header 'SecretKey: T1RVek*****' \
--header 'Region: cn-north-1' \
--header 'ServiceName: billing'\
--header 'Content-Type: application/json' \
--data-raw '{
    "BillPeriod":"2024-02",
    "Limit":1
}'

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202404021750412C935003765CD553A37B",
        "Action": "ListBillDetail",
        "Version": "20220101",
        "Service": "billing"
    },
    "Result": {
        "List": [
            {
                "BillPeriod": "2024-02",
                "ExpenseDate": "2024-02-29",
                "PayerID": "2100153894",
                "PayerUserName": "Doooo",
                "PayerCustomerName": "北京火山引擎科技有限公司",
                "SellerID": "3423",
                "SellerUserName": "火山引擎",
                "SellerCustomerName": "北京火山引擎科技有限公司",
                "OwnerID": "2100153894",
                "OwnerUserName": "Doooo",
                "OwnerCustomerName": "北京火山引擎科技有限公司",
                "BusinessMode": "普通业务",
                "Product": "volume",
                "ProductZh": "弹性块存储",
                "BillingMode": "按量计费",
                "ExpenseBeginTime": "2024-02-29 23:00:00",
                "ExpenseEndTime": "2024-03-01 00:00:00",
                "UseDuration": "3600",
                "UseDurationUnit": "秒",
                "TradeTime": "2024-03-01 00:24:14",
                "BillID": "Bill7341060462455001381",
                "BillCategory": "消费-使用",
                "InstanceNo": "vol-50mgf1r2g7l6hswihmfg",
                "InstanceName": "vol-50mgf1r2g7l6hswihmfg",
                "ConfigName": "系统盘-极速型SSD-PL0-按量计费",
                "Element": "EBS系统盘",
                "Region": "华北2(北京)",
                "Zone": "可用区B",
                "Factor": "类型-ESSD_PL0",
                "ExpandField": "",
                "Price": "0.001050",
                "PriceUnit": "GiB/时",
                "Count": "40",
                "Unit": "GiB",
                "DeductionCount": "0",
                "OriginalBillAmount": "0.042000",
                "PreferentialBillAmount": "0.036120",
                "DiscountBillAmount": "0.01",
                "CouponAmount": "0.00",
                "PayableAmount": "0.01",
                "PaidAmount": "0.00",
                "UnpaidAmount": "0.00",
                "Currency": "CNY",
                "SettlementType": "非结算",
                "Project": "default",
                "Tag": "",
                "SellingMode": "0",
                "SolutionZh": "",
                "SubjectName": "北京火山引擎科技有限公司",
                "RoundAmount": -0.00412,
                "BusiPeriod": "2024-02",
                "ReservationInstance": "0",
                "BillDetailId": "Detail7341060462454968613",
                "ElementCode": "BE001551",
                "RegionCode": "R000305",
                "ZoneCode": "cn-beijing-b",
                "FactorCode": "type-ESSD_PL0",
                "ConfigurationCode": "system-EBS_ESSD_PL0",
                "DeductionUseDuration": "0.0000000000",
                "CreditCarriedAmount": "0.00",
                "BillingFunction": "固定单价",
                "MarketPrice": "",
                "DiscountBizBillingFunction": "单一折扣",
                "DiscountBizUnitPrice": "0.14",
                "DiscountBizUnitPriceInterval": "-",
                "DiscountBizMeasureInterval": "-",
                "EffectiveFactor": "1",
                "PriceInterval": "-",
                "MeasureInterval": "-",
                "BillingMethodCode": "按配置小时结",
                "ProjectDisplayName": "默认项目"
            }
        ],
        "Total": 7721,
        "Limit": 1,
        "Offset": 0
    }
}

错误码

您可访问公共错误码,获取更多错误码信息。