查询资源消费记录
接口约束
- 该接口只允许使用客户AK/SK或者Token调用。
- 该接口只能查询同一个月内的资源消费记录,不支持跨月份查询资源消费记录。
- 当月数据查询结果仅供参考,不作为对账依据;当月最终账单在次月4日10点后支持查看/导出(月中会发生包括但不限于以下少数场景:延迟出账,退款,调账,欠费核销等)。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/bills/customer-bills/res-fee-records
URL参数说明请参见下表。
参数 |
是否必选 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|---|
X-Language |
否 |
String |
最大长度:10 |
语言。 en_US:英文 zh_CN:中文 |
参数 |
是否必选 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|---|
cycle |
是 |
String |
最大长度:10 |
查询的资源消费记录所在账期,东八区时间,格式:YYYY-MM。 |
charge_mode |
否 |
String |
最大长度:4 |
计费模式。
此参数不携带时,不作为筛选条件;不支持携带值为空或携带值为空串或携带值为null。 |
cloud_service_type |
否 |
String |
最大长度:64 |
云服务类型编码,例如OBS的云服务类型编码为“hws.service.type.obs”。您可以调用查询云服务类型列表接口获取。 此参数不携带时,不作为筛选条件;携带值为空或携带值为空串时,作为筛选条件。 |
region |
否 |
String |
最大长度:64 |
云服务区编码,例如:“ap-southeast-1”。具体请参见地区和终端节点对应云服务的“区域”列的值。 此参数不携带时,不作为筛选条件;携带值为空或携带值为空串时,作为筛选条件。 |
bill_type |
否 |
Integer |
- |
账单类型。
此参数不携带或携带值为空时,不作为筛选条件。 |
offset |
否 |
Integer |
[0-最大整数] |
偏移量,从0开始。默认值为0。
说明:
offset用于分页处理,如不涉及分页,请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1,则返回满足条件的第二个数据至最后一个数据。 示例1,满足查询条件的结果共10条数据,limit取值为10,offset取值为1,则返回的数据为2~10,第一条数据不返回。 示例2,查询总数20条,期望每页返回10条数据,则获取第一页数据,入参offset填写0,limit填写10;获取第二页数据,入参offset填写10,limit填写10。 |
limit |
否 |
Integer |
[1-1000] |
每次查询的数量限制。默认值为10。 |
resource_id |
否 |
String |
最大长度:64 |
资源ID。 此参数不携带时,不作为筛选条件;携带值为空或携带值为空串时,作为筛选条件。 |
enterprise_project_id |
否 |
String |
最大长度:64 |
企业项目标识(企业项目ID)。
此参数不携带或携带值为空或携带值为空串或携带值为null时,不作为筛选条件。 |
include_zero_record |
否 |
Boolean |
- |
返回是否包含应付金额为0的记录。
此参数不携带或携带值为空时,不作为筛选条件。 |
method |
否 |
String |
最大长度:64 |
查询资源消费记录的方式。
此参数不携带或携带值为空时,默认值为“all”,如果没有企业子客户,取值为all时查询的是客户自己的资源消费记录。 |
sub_customer_id |
否 |
String |
最大长度:64 |
企业子账号ID。 此参数携带值为空串时,不作为筛选条件。
说明:
|
trade_id |
否 |
String |
最大长度:64 |
订单ID或交易ID。 此参数不携带时,不作为筛选条件;携带值为空或携带值为空串时,作为筛选条件。
说明:
按账期类型统计时字段不生效。 |
bill_date_begin |
否 |
String |
最大长度:10 |
查询的资源消费记录的开始日期,东八区时间,格式为YYYY-MM-DD。 此参数不携带或携带值为空或携带值为空串时,默认值取cycle月份的第一天。
说明:
|
bill_date_end |
否 |
String |
最大长度:10 |
查询的资源消费记录的结束日期,东八区时间,格式为YYYY-MM-DD。 此参数不携带或携带值为空或携带值为空串时,默认值取cycle月份的最后一天。
说明:
|
statistic_type |
否 |
Integer |
- |
统计类型。默认值为3。
该参数不携带或携带值为空时,取默认值3。 |
请求消息
请求参数
无。
请求示例
GET https://bss-intl.myhuaweicloud.com/v2/bills/customer-bills/res-fee-records?cycle=2020-09&charge_mode=1&method=sub_customer&sub_customer_id=05b5fef62300d2ad0f98c00befba72c0&trade_id= CS1908201442ZLEPW476&bill_date_begin=2020-09-01&bill_date_end=2020-09-30&statistic_type=1 HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
响应消息
响应参数
参数 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|
error_code |
String |
最大长度:16 |
状态码。具体请参考状态码。只有失败才会返回这个参数。 |
error_msg |
String |
最大长度:1024 |
错误描述信息。只有失败才会返回这个参数。 |
fee_records |
List<ResFeeRecordV2> |
- |
资源费用记录数据。 具体请参见表3。 |
total_count |
Integer |
- |
结果集数量,只有成功才返回这个参数。 |
currency |
String |
最大长度:3 |
货币单位代码: USD:美元 |
参数 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|
bill_date |
String |
最大长度:20 |
资源消费记录的日期。 格式:YYYY-MM-DD。按照东八区时间截取。 |
bill_type |
Integer |
- |
账单类型。
|
customer_id |
String |
最大长度:64 |
消费的客户账号ID。
|
region |
String |
最大长度:64 |
云服务区编码,例如:“ap-southeast-1”。具体请参见地区和终端节点对应云服务的“区域”列的值。 |
region_name |
String |
最大长度:64 |
云服务区名称,例如:“中国-香港”。具体请参见地区和终端节点对应云服务的“区域名称”列的值。 |
cloud_service_type |
String |
最大长度:64 |
云服务类型编码,例如OBS的云服务类型编码为“hws.service.type.obs”。 |
resource_type |
String |
最大长度:64 |
资源类型编码,例如ECS的VM为“hws.resource.type.vm”。 |
cloud_service_type_name |
String |
最大长度:200 |
云服务类型名称。例如ECS的云服务类型名称为“弹性云服务器”。 |
resource_type_name |
String |
最大长度:200 |
资源类型名称。例如ECS的资源类型名称为“云主机”。 |
effective_time |
String |
最大长度:32 |
费用对应的资源使用的开始时间,按需有效,包年/包月该字段保留。 格式:yyyy-MM-dd'T'HH:mm:ss'Z'。按照UTC时间截取。 |
expire_time |
String |
最大长度:32 |
费用对应的资源使用的结束时间,按需有效,包年/包月该字段保留。 格式:yyyy-MM-dd'T'HH:mm:ss'Z'。按照UTC时间截取。 |
resource_id |
String |
最大长度:128 |
资源ID。 |
resource_name |
String |
最大长度:256 |
资源名称。
说明:
该参数返回值为用户在下单资源时手动填写的内容,不支持国际化。 |
resource_tag |
String |
最大长度:8192 |
资源标签。 |
product_id |
String |
最大长度:64 |
产品ID。 |
product_name |
String |
最大长度:256 |
产品名称。 |
product_spec_desc |
String |
最大长度:512 |
产品的规格描述。 |
sku_code |
String |
最大长度:64 |
SKU编码,在账单中唯一标识一个资源的规格。 |
spec_size |
BigDecimal |
- |
产品的实例大小,仅线性产品有效。
说明:
线性产品是指订购时需要指定大小的产品。例如硬盘在订购时需选择10G、20G等不同大小规格。 |
spec_size_measure_id |
Integer |
- |
产品实例大小的单位,仅线性产品有该字段。 您可以调用查询度量单位列表接口获取。 |
trade_id |
String |
最大长度:64 |
订单ID或交易ID,扣费维度的唯一标识。 |
id |
String |
最大长度:256 |
唯一标识。 按账期类型统计时不返回唯一标识。 |
trade_time |
String |
最大长度:32 |
交易时间。 格式:yyyy-MM-dd'T'HH:mm:ss'Z'。按照UTC时间截取。 |
enterprise_project_id |
String |
最大长度:128 |
企业项目标识(企业项目ID)。
|
enterprise_project_name |
String |
最大长度:256 |
企业项目的名称。
说明:
该参数返回值为用户手动填写的内容,不支持国际化。 |
charge_mode |
String |
最大长度:32 |
计费模式。
|
order_id |
String |
最大长度:64 |
订单ID。
说明:
包年/包月资源的使用记录才有该字段,按需资源则为空。 |
period_type |
String |
- |
周期类型:
|
usage_type |
String |
- |
资源使用量的类型,您可以调用查询使用量类型列表接口获取。 |
usage |
BigDecimal |
- |
资源的使用量。
说明:
查询包周期资源,不返回资源的使用量。 |
usage_measure_id |
Integer |
- |
资源使用量的度量单位,您可以调用查询度量单位列表接口获取。
说明:
查询包周期资源,不返回资源使用量的度量单位。 |
free_resource_usage |
BigDecimal |
- |
套餐内使用量。 |
free_resource_measure_id |
Integer |
- |
套餐内使用量的度量单位,您可以调用查询度量单位列表接口获取。 |
ri_usage |
BigDecimal |
- |
预留实例使用量。 |
ri_usage_measure_id |
Integer |
- |
预留实例使用量单位。 |
unit_price |
BigDecimal |
- |
产品的单价。
|
unit |
String |
最大长度:64 |
产品的单价单位。
说明:
|
official_amount |
BigDecimal |
- |
官网价,华为云商品在官网上未叠加应用商务折扣、促销折扣等优惠的销售价格。 |
discount_amount |
BigDecimal |
- |
优惠金额,用户使用云服务享受折扣优惠如商务折扣、伙伴授予折扣以及促销优惠等减免的金额。 |
amount |
BigDecimal |
- |
应付金额,用户使用云服务享受折扣优惠后需要支付的费用金额,包括代金券金额,精确到小数点后8位。
说明:
amount的值等于cash_amount,credit_amount,coupon_amount,flexipurchase_coupon_amount,stored_card_amount,bonus_amount,debt_amount,adjustment_amount的总和。 |
cash_amount |
BigDecimal |
- |
现金支付金额。 |
credit_amount |
BigDecimal |
- |
信用额度支付金额。 |
coupon_amount |
BigDecimal |
- |
代金券支付金额。 |
flexipurchase_coupon_amount |
BigDecimal |
- |
现金券支付金额。 |
stored_card_amount |
BigDecimal |
- |
储值卡支付金额。 |
bonus_amount |
BigDecimal |
- |
奖励金支付金额(用于现网客户未使用完的奖励金)。 |
debt_amount |
BigDecimal |
- |
欠费金额。 |
adjustment_amount |
BigDecimal |
- |
欠费核销金额。 |
measure_id |
Integer |
- |
金额单位。
|
formula |
String |
最大长度:2048 |
实付金额计算公式。当前只包含如下场景:
说明:
|
sub_service_type_code |
String |
最大长度:64 |
整机的子云服务的自身的云服务类型编码。 |
sub_service_type_name |
String |
最大长度:200 |
整机的子云服务的自身的云服务类型名称。 |
sub_resource_type_code |
String |
最大长度:64 |
整机的子云服务的自身的资源类型编码。 |
sub_resource_type_name |
String |
最大长度:200 |
整机的子云服务的自身的资源类型名称。 |
sub_resource_id |
String |
最大长度:64 |
整机的子云服务的自身的资源ID,资源标识。(如果为预留实例,则为预留实例标识) |
sub_resource_name |
String |
最大长度:256 |
整机的子云服务的自身的资源名称,资源标识。(如果为预留实例,则为预留实例标识)
说明:
该参数返回值为用户在下单资源时手动填写的内容,不支持国际化。 |
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Content-Length: length Date: response time { "fee_records": [ { "bill_date": "2020-12-21", "bill_type": 3, "customer_id": "8caf348df5fa4529aba5aea760608845", "region": "ap-southeast-1", "region_name": "CN North-Beijng1", "cloud_service_type": "hws.service.type.ebs", "resource_type": "hws.resource.type.volume", "effective_time": "2020-12-21T07:34:32Z", "expire_time": "2022-12-21T15:59:59Z", "resource_id": null, "resource_name": null, "resource_tag": null, "product_id": "90301-686007-0--0", "product_name": "", "product_spec_desc": "", "sku_code": "SAS", "spec_size": 300.0, "spec_size_measure_id": 17, "trade_id": "CS2012211533IQJR1", "id": "037e8a2b-bde9******eb5153cba_1", "trade_time": "2020-06-10T19:03:28Z", "enterprise_project_id": "0", "enterprise_project_name": "default", "charge_mode": "1", "order_id": "CS2012211533IQJR1", "period_type": "19", "usage_type": null, "usage": null, "usage_measure_id": null, "free_resource_usage": null, "free_resource_measure_id": null, "ri_usage": null, "ri_usage_measure_id": null, "unit_price": null, "unit": null, "official_amount": 2516.0, "discount_amount": 452.88, "amount": 2063.12, "cash_amount": 2063.12, "credit_amount": 0.0, "coupon_amount": 0.0, "flexipurchase_coupon_amount": 0.0, "stored_card_amount": 0.0, "bonus_amount": 0.0, "debt_amount": 0.0, "adjustment_amount": null, "measure_id": 1, "sub_service_type_code": null, "sub_service_type_name": null, "sub_resource_type_code": null, "sub_resource_type_name": null, "sub_resource_id": null, "sub_resource_name": null, "formula": "(1Year)【Number of Periods】/(1)【Period Conversion】*(100GB)【Resource Specifications】*(1.08Dollar/GB/Year)【Unit Price】-21.60【Discount】-0.00【Cash Coupon Used】" }, { "bill_date": "2020-12-21", "bill_type": 1, "customer_id": "8caf348df5fa4529aba5aea760608845", "region": "cn-north-1", "region_name": "CN North-Beijng1", "cloud_service_type": "hws.service.type.ebs", "resource_type": "hws.resource.type.volume", "effective_time": "2020-12-21T07:28:12Z", "expire_time": null, "resource_id": null, "resource_name": null, "resource_tag": null, "product_id": "90301-526111-0--0", "product_name": "EVS_SATA_5 years", "product_spec_desc": "EVS_SATA_LXH01|100.0 GB", "sku_code": "SATA_LXH01", "spec_size": 100.0, "spec_size_measure_id": 17, "trade_id": "CS2012211528IP5Q1", "id": "037e8a2b-bde9-******-5f9eb5153cba_1", "trade_time": "2020-06-10T17:03:28Z", "enterprise_project_id": "0", "enterprise_project_name": "default", "charge_mode": "1", "order_id": "CS2012211528IP5Q1", "period_type": "19", "usage_type": null, "usage": null, "usage_measure_id": null, "free_resource_usage": null, "free_resource_measure_id": null, "ri_usage": null, "ri_usage_measure_id": null, "unit_price": null, "unit": null, "official_amount": 4.0, "discount_amount": 0, "amount": 4.0, "cash_amount": 4.0, "credit_amount": 0.0, "coupon_amount": 0.0, "flexipurchase_coupon_amount": 0.0, "stored_card_amount": 0.0, "bonus_amount": 0.0, "debt_amount": 0.0, "adjustment_amount": null, "measure_id": 1, "formula": "(1Year)【Number of Periods】/(1)【Period Conversion】*(100GB)【Resource Specifications】*(1.08Dollar/GB/Year)【Unit Price】-21.60【Discount】-0.00【Cash Coupon Used】" } ], "total_count": 40, "currency": "USD" }