客户运营能力-查询资源详单:请求消息

时间:2024-05-23 13:59:06

请求消息

请求参数

参数

是否必选

参数类型

取值范围

描述

cycle

String

最大长度:8

查询的资源详单所在账期,东八区时间,格式为YYYY-MM。

示例:2019-01。

cloud_service_type

String

最大长度:64

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

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

resource_type

String

最大长度:64

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

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

region

String

最大长度:64

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

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

res_instance_id

String

最大长度:64

资源实例ID。

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

charge_mode

Integer

-

计费模式。

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

此参数不携带或者携带值为null时,返回所有计费模式的资源详单数据记录。

bill_type

Integer

-

账单类型:

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

此参数不携带或者携带值为null时,返回所有账单类型的资源详单数据记录。

enterprise_project_id

String

最大长度:64

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

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

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

include_zero_record

Boolean

-

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

  • true: 包含
  • false: 不包含

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

method

String

最大长度:64

查询方式。

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

此参数不携带或携带值为空串或携带值为null时,默认值为“all”,如果没有企业子客户,all的时候也是查询客户自己的数据。

说明:

若需要查询财务独立企业子的账单信息,前提是子账号已经接受了企业主账号的“允许查看子账号消费信息”的申请。申请方法见“变更子账号权限”。

sub_customer_id

String

最大长度:64

企业子账号ID。

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

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。

statistic_type

Integer

[1-2]

统计类型。默认值为1。

  • 1:按账期
  • 2:按天

该参数不携带或携带值为null时,取默认值1;不支持携带为空串。

query_type

String

[0-9]

查询类型。默认值为BILLCYCLE。

  • BILLCYCLE:按月
  • DAILY:按天

仅当statistic_type=2时,支持传递query_type=DAILY。

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

bill_cycle_begin

String

[0-10]

账期开始时间。格式为YYYY-MM-DD。

仅当query_type=DAILY时,必须传递账期开始时间。

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

说明:
  • 如果query_type取值不为DAILY,则该参数无效。
  • 如果query_type取值为DAILY,则该参数不能为空,必须和cycle(即资源详单所在账期)在同一个月。

bill_cycle_end

String

[0-10]

账期结束时间。格式为YYYY-MM-DD。

仅当query_type=DAILY时,必须传递账期结束时间。

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

说明:
  • 如果query_type取值不为DAILY,则该参数无效。
  • 如果query_type取值为DAILY,则该参数不能为空,必须和cycle(即资源详单所在账期)在同一个月。

请求示例

POST https://bss.myhuaweicloud.com/v2/bills/customer-bills/res-records/query HTTP/1.1
Content-Type: application/json
X-Auth-TokenMIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
{
      "cycle": "2018-12",
      "cloud_service_type": "hws.service.type.ec2",
      "resource_type": "hws.resource.type.vm",
      "region": "cn-north-1",
      "res_instance_id": "76*****7f",
      "charge_mode": 1,
      "bill_type": 1,
      "enterprise_project_id": "6***f3-3**4-4**2-9a3e-a****c24",
      "include_zero_record": "true",
       "method": "sub_customer",
       "sub_customer_id": "05b5fef62300d2ad0f98c00befba72c0",
      "offset": 1,
      "limit": 10
}
support.huaweicloud.com/api-oce/mbc_00003.html