客户运营能力-查询资源消费记录:URI

时间:2024-05-30 21:07:57

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:预留实例
  • 11:节省计划

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

cloud_service_type

String

最大长度:64

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

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

region

String

最大长度:64

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

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

bill_type

Integer

-

账单类型。

  • 1:消费-新购
  • 2:消费-续订
  • 3:消费-变更
  • 4:退款-退订
  • 5:消费-使用
  • 8:消费-自动续订
  • 9:调账-补偿
  • 12:消费-按时计费
  • 13:消费-退订手续费
  • 14:消费-服务支持计划月末扣费
  • 16:调账-扣费
  • 18:消费-按月付费
  • 20:退款-变更
  • 23:消费-节省计划抵扣
  • 24:退款-包年/包月转按需

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

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
  • 其余项目对应ID获取方法请参见如何获取企业项目ID

此参数不携带或携带值为空或携带值为空串或携带值为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时此处为订单ID。
  • 账单类型为其它场景时此处为交易ID,为扣费维度的唯一标识。

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

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

说明:

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

bill_date_begin

String

最大长度:20

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

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

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

bill_date_end

String

最大长度:20

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

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

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

statistic_type

Integer

-

统计类型。默认值为3。

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

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

support.huaweicloud.com/api-oce/mbc_00004.html