查询客户消费记录(旧)
功能介绍
伙伴在伙伴销售平台可实时查询某个代售类客户的消费记录,了解客户的资源消耗情况。
伙伴在伙伴中心查询客户消费明细请参见这里。
- 消费记录支持查询18个月内的记录。
- 该接口即将下线,“查询客户消费记录”新接口请参考查询伙伴子客户消费记录。
接口约束
该接口只允许使用合作伙伴AK/SK或者Token调用。
URI
GET /v2/bills/partner-bills/subcustomer-bills/res-fee-records
参数说明请参见表1-1。
参数 |
是否必选 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|---|
customer_id |
是 |
String |
最大长度:64 |
客户账号ID。您可以调用查询客户列表接口获取customer_id。 |
cycle |
是 |
String |
最大长度:10 |
查询的客户消费记录所在账期,格式:YYYY-MM。 |
charge_mode |
是 |
String |
最大长度:4 |
计费模式。
|
cloud_service_type |
否 |
String |
最大长度:64 |
云服务类型编码,例如OBS的云服务类型编码为“hws.service.type.obs”。您可以调用查询云服务类型列表接口获取。 此参数不携带或携带值为空时,不作为筛选条件;携带值为空串时,作为筛选条件。 |
region |
否 |
String |
最大长度:64 |
云服务区编码,例如:“cn-north-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。 此参数不携带时,不作为筛选条件;携带值为空串或携带值为空时,作为筛选条件。 |
include_zero_record |
否 |
Boolean |
- |
返回是否包含应付金额为0的记录。
此参数不携带或携带值为空时,不作为筛选条件;携带值为空串时,作为筛选条件。 |
indirect_partner_id |
否 |
String |
最大长度:64 |
云经销商ID。获取方法请参见查询云经销商列表。 如果华为云总经销商需要查询客户在云经销商关联期间的消费,需要携带该字段;除此之外,此参数不做处理。否则只能查询该客户在与自己关联期间的消费。 |
bill_date_begin |
否 |
String |
最大长度:10 |
查询的资源消费记录的开始日期,格式为YYYY-MM-DD。 此参数不携带或携带值为空或携带值为空串时,默认值取cycle月份的第一天。
说明:
必须和cycle(即资源的消费账期)在同一个月。 |
bill_date_end |
否 |
String |
最大长度:10 |
查询的资源消费记录的结束日期,格式为YYYY-MM-DD。 此参数不携带或携带值为空或携带值为空串时,默认值取cycle月份的最后一天。
说明:
|
请求消息
请求参数
无。
请求示例
GET https://bss.myhuaweicloud.com/v2/bills/partner-bills/subcustomer-bills/res-fee-records?customer_id=06a29ceaae80d2400fc0c01027684d40&cycle=2020-04&cloud_service_type=hws.service.type.ec2®ion=cn-north-1&charge_mode=1&bill_type=1&offset=0&limit=10&resource_id=f4a7ed17-dcbd-4554-b26b-248ea46c056a&include_zero_record=true&indirect_partner_id=c9e731c4663646988ef4cdb3122837b6 HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
响应消息
响应参数
参数 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|
error_code |
String |
最大长度:16 |
状态码。具体请参考状态码。只有失败才会返回这个参数。 |
error_msg |
String |
最大长度:1024 |
错误描述信息。只有失败才会返回这个参数。 |
fee_records |
List<SubCustomerResFeeRecordV2> |
- |
客户的消费记录数据。 具体请参见表2。 |
count |
Integer |
- |
结果集数量,只有成功才返回这个参数。 |
currency |
String |
最大长度:3 |
币种。 CNY:人民币 |
参数 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|
effective_time |
String |
最大长度:32 |
消费记录对应的资源使用的开始时间。
说明:
按需有效,包年/包月该字段保留。 |
expire_time |
String |
最大长度:32 |
消费记录对应的资源使用的结束时间。
说明:
按需有效,包年/包月该字段保留。 |
product_id |
String |
最大长度:64 |
产品ID。 |
product_name |
String |
最大长度:256 |
产品名称。 |
order_id |
String |
最大长度:64 |
订单ID。
说明:
包年/包月资源的使用记录才有该字段,按需资源为空。 |
amount |
BigDecimal |
- |
消费金额,包括现金券和代金券金额,精确到小数点后2位。
说明:
amount的值等于cash_amount,credit_amount,coupon_amount,flexipurchase_coupon_amount,stored_card_amount,bonus_amount,debt_amount,adjustment_amount的总和。 |
measure_id |
Integer |
- |
金额单位:
|
usage_type |
String |
- |
资源的使用量类型,您可以调用查询使用量类型列表接口获取。 |
usage |
BigDecimal |
- |
资源的使用量。 |
usage_measure_id |
Integer |
- |
资源的使用量单位,您可以调用查询度量单位列表接口获取。 |
free_resource_usage |
BigDecimal |
- |
套餐内使用量。 |
free_resource_measure_id |
Integer |
- |
套餐内使用量单位,您可以调用查询度量单位列表接口获取。 |
cloud_service_type |
String |
最大长度:64 |
云服务类型编码,例如OBS的云服务类型编码为“hws.service.type.obs”。您可以调用查询云服务类型列表接口获取。 |
region |
String |
最大长度:64 |
云服务区编码,例如:“cn-north-1”。具体请参见地区和终端节点对应云服务的“区域”列的值。 |
resource_type |
String |
最大长度:64 |
资源类型编码,例如ECS的VM为“hws.resource.type.vm”。您可以调用查询资源类型列表接口获取。 |
cloud_service_type_name |
String |
最大长度:200 |
云服务类型名称。例如ECS的云服务类型名称为“弹性云服务器”。 |
resource_type_name |
String |
最大长度:200 |
资源类型名称。例如ECS的资源类型名称为“云主机”。 |
charge_mode |
String |
最大长度:32 |
计费模式。
|
resource_tag |
String |
最大长度:1024 |
资源标签。 |
resource_name |
String |
最大长度:256 |
资源名称。 |
resource_id |
String |
最大长度:64 |
资源ID。 |
bill_type |
Integer |
- |
账单类型。
|
period_type |
String |
- |
周期类型:
说明:
charge_mode取值为“1:包年/包月资源”或“10:预留实例”时该参数才有值;charge_mode取值为“3:按需资源”时该参数为空。 |
ri_usage |
BigDecimal |
- |
预留实例使用量。 |
ri_usage_measure_id |
Integer |
- |
预留实例使用量单位。 |
official_amount |
BigDecimal |
- |
官网价。 |
discount_amount |
BigDecimal |
- |
折扣金额 |
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 |
- |
欠费核销金额。 |
spec_size |
BigDecimal |
- |
产品的实例大小,仅线性产品有效。 线性产品为包括硬盘,带宽等在订购时需要指定大小的产品。例如硬盘在订购时需选择10G、20G等不同大小。 |
spec_size_measure_id |
Integer |
- |
产品实例大小的单位,仅线性产品有该字段。您可以调用查询度量单位列表接口获取。 |
product_spec_desc |
String |
最大长度:512 |
产品的规格描述。例如:“普通IO|100.0GB”。 |
region_name |
String |
最大长度:64 |
云服务区名称,例如:“华北-北京”。具体请参见地区和终端节点对应云服务的“区域名称”列的值。 |
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": [ { "effective_time": "2019-12-17T10:32:02Z", "expire_time": "2019-12-17T10:32:02Z", "product_id": "00301-258036-0--1", "product_name": "test001", "order_id": "CS1904251009QCBFS", "amount": 100.99, "measure_id": "1", "usage_type": "", "usage": 10, "usage_measure_id": "0", "free_resource_usage": 100.99, "free_resource_measure_id": "0", "cloud_service_type": "hws.service.type.ec2", "region": "cn-north-1", "resource_type": "hws.resource.type.vm", "charge_mode": "1", "resource_tag": "", "resource_name": "", "resource_id": "f4a7ed17-dcbd-4554-b26b-248ea46c056a", "bill_type": "1", "period_type": "24", "ri_usage": 100.99, "ri_usage_measure_id": "0", "official_amount": 100.99, "discount_amount": 100.99, "cash_amount": 100.99, "credit_amount": 100.99, "coupon_amount": 100.99, "flexipurchase_coupon_amount": 100.99, "stored_card_amount": 100.99, "bonus_amount": 100.99, "debt_amount": 100.99, "adjustment_amount": 100.99, "spec_size": 100.99, "spec_size_measure_id": 17, "product_spec_desc": "普通IO|100.0GB", "region_name": "华北-北京一", "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 } ], "count": "10", "currency": "CNY" }