客户运营能力客户运营能力

文档首页> 客户运营能力> API参考> 管理账单> 查询资源消费记录
更新时间:2021/09/08 GMT+08:00
分享

查询资源消费记录

功能介绍

客户在自建平台查询每个资源的消费明细数据。

客户登录费用中心查询资源消费记录请参见这里

接口约束

  • 该接口只允许使用客户AK/SK或者Token调用。
  • 该接口只能查询同一个月内的资源消费记录,不支持跨月份查询资源消费记录。

调试

您可以在API Explorer中直接运行调试该接口。

URI

GET /v2/bills/customer-bills/res-fee-records

URL参数说明请参见下表。

表1 消息头参数

参数

是否必选

参数类型

取值范围

描述

X-Language

String

最大长度:10

语言。

en_US:英文

zh_CN:中文

表2 查询参数

参数

是否必选

参数类型

取值范围

描述

cycle

String

最大长度:10

查询的资源消费记录所在账期,格式:YYYY-MM。

charge_mode

String

最大长度:4

计费模式。

  • 1:包年/包月
  • 3:按需
  • 10:预留实例

cloud_service_type

String

最大长度:64

云服务类型编码,例如ECS的云服务类型编码为“hws.service.type.ec2”。您可以调用查询云服务类型列表接口获取。

region

String

最大长度:64

云服务区编码,例如:“cn-north-1”。具体请参见地区和终端节点对应云服务的“区域”列的值。

bill_type

Integer

-

账单类型。

  • 1:消费-新购
  • 2:消费-续订
  • 3:消费-变更
  • 4:退款-退订
  • 5:消费-使用
  • 8:消费-自动续订
  • 9:调账-补偿
  • 14:消费-服务支持计划月末扣费
  • 16:调账-扣费

offset

Integer

[0-最大整数]

偏移量,从0开始。默认值为0。

说明:

offset用于分页处理,如不涉及分页,请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1,则返回满足条件的第二个数据至最后一个数据。

例如,满足查询条件的结果共10条数据,limit取值为10,offset取值为1,则返回的数据为2~10,第一条数据不返回。

limit

Integer

[1-1000]

每次查询的数量限制。默认值为10。

resource_id

String

最大长度:256

资源ID。

enterprise_project_id

String

最大长度:64

企业项目标识(企业项目ID)。

  • default项目对应ID:0
  • 未归集(表示该云服务不支持企业项目管理能力)项目对应ID:-1
  • 其余项目对应ID获取方法请参见如何获取企业项目ID

include_zero_record

Boolean

-

返回是否包含应付金额为0的记录。

  • true:包含
  • false:不包含

method

String

最大长度:64

查询资源消费记录的方式。

  • oneself:客户自己
  • sub_customer:企业子客户
  • all:客户自己和企业子客户

默认为all,如果没有企业子客户,取值为all时查询的是客户自己的资源消费记录。

sub_customer_id

String

最大长度:64

企业子账号ID。

说明:
  • 如果method取值不为sub_customer,则该参数无效。
  • 如果method取值为sub_customer,则该参数不能为空。

trade_id

String

最大长度:64

订单ID或交易ID。

  • 账单类型为1、2、3、4和8时此处为订单ID。
  • 账单类型为其它场景时此处为交易ID,为扣费维度的唯一标识。

    例如非月末扣费时为应收ID;月末扣费时为账单ID。

bill_date_begin

String

最大长度:20

查询的资源消费记录的开始日期,格式为YYYY-MM-DD。

说明:
  • 必须和cycle(即资源的消费账期)在同一个月。
  • bill_date_begin和bill_date_end两个参数必须同时出现,否则仅按照cycle(即资源的消费账期)进行查询。

bill_date_end

String

最大长度:20

查询的资源消费记录的结束日期,格式为YYYY-MM-DD。

说明:
  • 必须和cycle(即资源的消费账期)在同一个月。
  • bill_date_begin和bill_date_end两个参数必须同时出现,否则仅按照cycle(即资源的消费账期)进行查询。

请求消息

请求参数

无。

请求示例

GET https://bss.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 HTTP/1.1
Content-Type: application/json
X-Auth-TokenMIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

响应消息

响应参数

参数

参数类型

取值范围

描述

error_code

String

最大长度:16

状态码。具体请参考状态码。只有失败才会返回这个参数。

error_msg

String

最大长度:1024

错误描述信息。只有失败才会返回这个参数。

fee_records

List<ResFeeRecordV2>

-

资源费用记录数据。

具体请参见表3

total_count

Integer

-

结果集数量,只有成功才返回这个参数。

currency

String

最大长度:3

货币单位代码:

CNY:人民币

表3 ResFeeRecordV2

参数

参数类型

取值范围

描述

bill_date

String

最大长度:20

资源消费记录的日期。

格式:YYYY-MM-DD。按照东八区截取。

bill_type

Integer

-

账单类型。

  • 1:消费-新购
  • 2:消费-续订
  • 3:消费-变更
  • 4:退款-退订
  • 5:消费-使用
  • 8:消费-自动续订
  • 9:调账-补偿
  • 14:消费-服务支持计划月末扣费
  • 16:调账-扣费

customer_id

String

最大长度:64

消费的客户账号ID。

  • 如果是普通客户或者企业子查询消费记录,只能查询到自身的消费记录,则这个地方显示的是自身的客户ID
  • 如果是企业主查询消费记录,可以查询到自身以及企业子的消费记录,这个地方是消费的实际客户ID,如果是企业主自身消费,为企业主ID,如果这条消费记录是某个企业子客户的消费,这个地方的ID是企业子账号ID。

region

String

最大长度:64

云服务区编码,例如:“cn-north-1”。具体请参见地区和终端节点对应云服务的“区域”列的值。

region_name

String

最大长度:64

云服务区名称,例如:“华北-北京一”。具体请参见地区和终端节点对应云服务的“区域名称”列的值。

cloud_service_type

String

最大长度:64

云服务类型编码,例如ECS的云服务类型编码为“hws.service.type.ec2”。您可以调用查询云服务类型列表接口获取。

resource_type

String

最大长度:64

资源类型编码,例如ECS的VM为“hws.resource.type.vm”。您可以调用查询资源类型列表接口获取。

effective_time

String

最大长度:32

费用对应的资源使用的开始时间,按需有效,包年/包月该字段保留。

expire_time

String

最大长度:32

费用对应的资源使用的结束时间,按需有效,包年/包月该字段保留。

resource_id

String

最大长度:128

资源ID。

resource_name

String

最大长度:256

资源名称。

resource_tag

String

最大长度:1024

资源标签。

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,扣费维度的唯一标识。

trade_time

String

最大长度:32

交易时间。

enterprise_project_id

String

最大长度:128

企业项目标识(企业项目ID)。

  • default项目对应ID:0
  • 未归集(表示该云服务不支持企业项目管理能力)项目对应ID:-1
  • 其余项目对应ID获取方法请参见如何获取企业项目ID

enterprise_project_name

String

最大长度:256

企业项目的名称。

charge_mode

String

最大长度:32

计费模式。

  • 1:包年/包月
  • 3:按需
  • 10:预留实例

order_id

String

最大长度:64

订单ID。

说明:

包年/包月资源的使用记录才有该字段,按需资源则为空。

period_type

String

-

周期类型:

  • 19:年
  • 20:月
  • 24:天
  • 25:小时
  • 5:一次性

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

产品的单价单位。

  • 线性产品的单价单位为“元/{线性单位}/月”或“元/{线性单位}/小时”等。
  • 非线性产品的单价单位为“元/月”或“元/小时”等。
说明:

“线性单位”为线性产品(订购时需要指定大小的产品)的大小的单位,比如硬盘的线性单位为GB,带宽的线性单位为Mbps。

official_amount

BigDecimal

-

官网价,华为云商品在官网上未叠加应用商务折扣、促销折扣等优惠的销售价格。

discount_amount

BigDecimal

-

优惠金额,用户使用云服务享受折扣优惠如商务折扣、伙伴授予折扣以及促销优惠等减免的金额。

amount

BigDecimal

-

应付金额,用户使用云服务享受折扣优惠后需要支付的费用金额,包括现金券和储值卡和代金券金额,精确到小数点后2位。

说明:

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

-

金额单位。

  • 1:元

响应示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time  
{
    "fee_records": [
        {
            "bill_date": "2020-12-06",
            "bill_type": 1,
            "customer_id": "52190d93cb844a249c70fd1e1d416f8b",
            "region": "cn-north-1",
            "region_name": "CN North-Beijing1",
            "cloud_service_type": "hws.service.type.vpc",
            "resource_type": "hws.resource.type.pm",
            "effective_time": "2020-12-06T11:06:55Z",
            "expire_time": "2020-12-07T11:06:55Z",
            "resource_id": "4251f987c09c4d97a6b4784e4661f8ce",
            "resource_name": "hws.service.type.vpcname",
            "resource_tag": "resourceTag",
            "product_id": "90301-686010-0--0",
            "product_name": "全动态BGP弹性IP_包月_北京一 北京四",
            "product_spec_desc": "动态BGP弹性IP",
            "sku_code": "5_bgp",
            "spec_size": 40,
            "spec_size_measure_id": 0,
            "trade_id": "BC0883684711",
            "trade_time": "2020-12-06T11:07:00Z",
            "enterprise_project_id": "0",
            "enterprise_project_name": "default",
            "charge_mode": "1",
            "order_id": "BC0883684711",
            "period_type": "20",
            "usage_type": "sdjhgkf",
            "usage": 101,
            "usage_measure_id": 1,
            "free_resource_usage": 123,
            "free_resource_measure_id": 1,
            "ri_usage": 30,
            "ri_usage_measure_id": 0,
            "unit_price": 0,
            "unit": "元/1个(次)",
            "official_amount": 34.96,
            "discount_amount": 0.002,
            "amount": 34.96,
            "cash_amount": 1.23,
            "credit_amount": 1.24,
            "coupon_amount": 0.33,
            "flexipurchase_coupon_amount": 22.5,
            "stored_card_amount": 12.13,
            "bonus_amount": 2.4,
            "debt_amount": -4.87,
            "adjustment_amount": 2.58,
            "measure_id": 1
        },
        {
            "bill_date": "2020-12-05",
            "bill_type": 1,
            "customer_id": "52190d93cb844a249c70fd1e1d416f8b",
            "region": "cn-north-1",
            "region_name": "CN North-Beijing1",
            "cloud_service_type": "hws.service.type.vpc",
            "resource_type": "hws.resource.type.ip",
            "effective_time": "2020-12-05T11:06:55Z",
            "expire_time": "2020-12-06T11:06:55Z",
            "resource_id": "4251f987c09c4d97a6b4784e4661f8ce",
            "resource_name": "hws.service.type.vpcname",
            "resource_tag": "resourceTag",
            "product_id": "00301-110660-0--0",
            "product_name": "调试15_4核8G_linux 包年",
            "product_spec_desc": "调试15_4核8G_linux",
            "sku_code": "comtest15.linux",
            "spec_size": 40,
            "spec_size_measure_id": 0,
            "trade_id": "BC0883684711",
            "trade_time": "2020-12-05T11:07:00Z",
            "enterprise_project_id": "0",
            "enterprise_project_name": "default",
            "charge_mode": "1",
            "order_id": "BC0883684711",
            "period_type": "20",
            "usage_type": "dsfhjgbk",
            "usage": 147,
            "usage_measure_id": 1,
            "free_resource_usage": 258,
            "free_resource_measure_id": 1,
            "ri_usage": 30,
            "ri_usage_measure_id": 0,
            "unit_price": 0,
            "unit": "元/1个(次)",
            "official_amount": 0.81,
            "discount_amount": 0.01,
            "amount": 0.81,
            "cash_amount": 2.25,
            "credit_amount": 1.23,
            "coupon_amount": 0.07,
            "flexipurchase_coupon_amount": 0.4,
            "stored_card_amount": 0.34,
            "bonus_amount": 4.63,
            "debt_amount": -8.11,
            "adjustment_amount": 3.69,
            "measure_id": 1
        }
    ],
    "total_count": 2,
    "currency": "CNY"
}

状态码

HTTP状态码

错误码

错误描述

400

CBC.0100

参数错误。

403

CBC.0151

访问拒绝。

500

CBC.0999

未知错误。

分享:

    相关文档

    相关产品