查询资源消费记录

X-Language

否

String

最大长度：10

语言。

en_US：英文

zh_CN：中文

cycle

是

String

最大长度：10

查询的资源消费记录所在账期，东八区时间，格式：YYYY-MM。

charge_mode

否

String

最大长度：4

计费模式。

• 1：包年/包月
• 3：按需
• 10：预留实例
• 11：节省计划

此参数不携带时，不作为筛选条件；不支持携带值为空或携带值为空串或携带值为null。

cloud_service_type

否

String

最大长度：64

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

此参数不携带时，不作为筛选条件；携带值为空或携带值为空串时，作为筛选条件。

region

否

String

最大长度：64

云服务区编码，例如：“ap-southeast-1”。具体请参见地区和终端节点对应云服务的“区域”列的值。

此参数不携带时，不作为筛选条件；携带值为空或携带值为空串时，作为筛选条件。

bill_type

否

Integer

-

账单类型。

• 1：消费-新购
• 2：消费-续订
• 3：消费-变更
• 4：退款-退订
• 5：消费-使用
• 8：消费-自动续订
• 9：调账-补偿
• 12：消费-按时计费
• 13：消费-退订手续费
• 14：消费-服务支持计划月末扣费
• 15：消费-税金
• 16：调账-扣费
• 17：消费-保底差额
  说明：

  保底差额=客户签约保底合同后，如果没有达到保底消费，客户需要补交的费用，仅限于直销或者伙伴顾问销售类子客户，且为后付费用户。

• 20：退款-变更
• 23：消费-节省计划抵扣
• 24：退款-包年/包月转按需
• 100：退款-退订税金
• 101：调账-补偿税金
• 102：调账-扣费税金

此参数不携带或携带值为空时，不作为筛选条件。

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）。

• default项目对应ID：0
• 未归集（表示该云服务不支持企业项目管理能力）项目对应ID：-1

此参数不携带或携带值为空或携带值为空串或携带值为null时，不作为筛选条件。

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和103时此处为订单ID。
• 账单类型为其它场景时此处为交易ID，为扣费维度的唯一标识。

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

此参数不携带时，不作为筛选条件；携带值为空或携带值为空串时，作为筛选条件。

说明：

按账期类型统计时字段不生效。

bill_date_begin

否

String

最大长度：10

查询的资源消费记录的开始日期，东八区时间，格式为YYYY-MM-DD。

此参数不携带或携带值为空或携带值为空串时，默认值取cycle月份的第一天。

说明：

• 必须和cycle（即资源的消费账期）在同一个月。

• bill_date_begin和bill_date_end两个参数必须同时出现，否则仅按照cycle（即资源的消费账期）进行查询。
• 按账期类型统计时字段不生效。

bill_date_end

否

String

最大长度：10

查询的资源消费记录的结束日期，东八区时间，格式为YYYY-MM-DD。

此参数不携带或携带值为空或携带值为空串时，默认值取cycle月份的最后一天。

说明：

• 必须和cycle（即资源的消费账期）在同一个月。
• bill_date_begin和bill_date_end两个参数必须同时出现，否则仅按照cycle（即资源的消费账期）进行查询。
• 按账期类型统计时字段不生效。

statistic_type

否

Integer

-

统计类型。默认值为3。

• 1：按账期
• 3：按明细

该参数不携带或携带值为空时，取默认值3。

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

-

账单类型。

• 1：消费-新购
• 2：消费-续订
• 3：消费-变更
• 4：退款-退订
• 5：消费-使用
• 8：消费-自动续订
• 9：调账-补偿
• 12：消费-按时计费
• 13：消费-退订手续费
• 14：消费-服务支持计划月末扣费
• 15：消费-税金
• 16：调账-扣费
• 17：消费-保底差额
  说明：

  保底差额=客户签约保底合同后，如果没有达到保底消费，客户需要补交的费用，仅限于直销或者伙伴顾问销售类子客户，且为后付费用户。

• 20：退款-变更
• 23：消费-节省计划抵扣
• 24：退款-包年/包月转按需
• 100：退款-退订税金
• 101：调账-补偿税金
• 102：调账-扣费税金

customer_id

String

最大长度：64

消费的客户账号ID。

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

• default项目对应ID：0
• 未归集（表示该云服务不支持企业项目管理能力）项目对应ID：null

enterprise_project_name

String

最大长度：256

企业项目的名称。

说明：

该参数返回值为用户手动填写的内容，不支持国际化。

charge_mode

String

最大长度：32

计费模式。

• 1：包年/包月
• 3：按需
• 10：预留实例
• 11：节省计划

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

-

应付金额，用户使用云服务享受折扣优惠后需要支付的费用金额，包括代金券金额，精确到小数点后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

-

金额单位。

• 1：美元

formula

String

最大长度：2048

实付金额计算公式。当前只包含如下场景：

• 按需非线性定价

  {使用量}【使用量】/{单位转化率}【单位转换】*{单价}【单价】-{优惠金额}【优惠金额】-{抹零金额}【抹零金额】-{代金券抵扣}【代金券抵扣】

• 按需线性定价

  {使用量}【使用量】/{单位转化率}【单位转换】*{线性大小}【规格】*{单价}【单价】-{优惠金额}【优惠金额】-{抹零金额}【抹零金额】-{代金券抵扣}【代金券抵扣】

• 包年包月新购和续订非线性定价

  {周期数}【周期数】/{周期转化率}【周期转换】*{单价}【单价】-{优惠金额}【优惠金额】-{代金券抵扣}【代金券抵扣】

• 包年包月新购和续订线性定价

  {周期数}【周期数】/{周期转化率}【周期转换】*{线性大小}【规格】*{单价}【单价】-{优惠金额}【优惠金额】-{代金券抵扣}【代金券抵扣】

• 包年包月（一次性）新购和续订非线性定价

  {单价}【单价】-{优惠金额}【优惠金额】-{代金券抵扣}【代金券抵扣】

• 包年包月（一次性）新购和续订线性定价

  {线性大小}【规格】*{单价}【单价】-{优惠金额}【优惠金额】-{代金券抵扣}【代金券抵扣】

说明：

• 实付金额计算公式得到的金额值等于amount - coupon_amount的差值。
• 按账期类型查询时不返回计算公式。

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

整机的子云服务的自身的资源名称，资源标识。（如果为预留实例，则为预留实例标识）

说明：

该参数返回值为用户在下单资源时手动填写的内容，不支持国际化。

consume_time

String

最大长度：32

消费时间。

格式：yyyy-MM-dd'T'HH:mm:ss'Z'。按照UTC时间截取。

• 包年/包月：与账单交易时间一致。
• 按需/分期：为账单的计费开始时间和结束时间。

说明：

• 当统计类型statistic_type=3时，该字段才有值。

relative_order_id

String

最大长度：64

客户订单关联的订单ID。

说明：

当order_id为组合交易订单且为包年/包月资源时，该字段才有值，当查询为普通订单时，此字段返回为空。

400

CBC.0100

参数错误。

403

CBC.0151

访问拒绝。

500

CBC.0999

未知错误。