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

更新时间:2021/06/29 GMT+08:00
分享

查询月度成本

功能介绍

客户可以查询某月的月度成本,月度成本为按使用量类型、按资源或产品维度分摊到每个月的费用,当前支持查看近18个月的月度成本。

客户登录费用中心查询月度成本请参见这里

包年/包月或预留实例的预付金额的查询月,为根据订单行的生失效时间分摊所在月;按需或预留实例按时计费的查询月,和账期相同,为按交易时间累加的用量所在月。

接口约束

该接口只允许使用客户AK/SK或者Token调用。

调试

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

URI

GET /v2/costs/cost-analysed-bills/monthly-breakdown

URL参数说明请参见下表。
表1 消息头参数

参数

是否必选

参数类型

取值范围

描述

X-Language

String

最大长度:10

语言。

en_US:英文

zh_CN:中文

表2 查询参数

参数

是否必选

参数类型

取值范围

描述

shared_month

String

最大长度:10

查询分摊成本的月份,格式:YYYY-MM。

charging_mode

Integer

[1-10]

计费模式。

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

service_type_code

String

最大长度:64

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

resource_type_code

String

最大长度:64

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

region_code

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。

resource_name

String

最大长度:256

资源名称

enterprise_project_id

String

最大长度:64

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

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

method

String

最大长度:64

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

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

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

sub_customer_id

String

最大长度:64

企业子账号ID。

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

请求消息

请求参数

无。

请求示例

GET https://bss.myhuaweicloud.com/v2/costs/cost-analysed-bills/monthly-breakdown?shared_month=2020-02&charging_mode=1&service_type_code=hws.service.type.ec2&resource_type_code=hws.resource.type.vm&region_code=cn-east-2&bill_type=2&offset=0&limit=10&resource_id=c8d5f0c83&resource_name=_node_core_UfqMv&enterprise_project_id=430A093D231C423BBD215DCDD6842319&method=all&sub_customer_id=07fe2821e4802f8d0f26c0129657a4a0 HTTP/1.1
Content-Type: application/json
X-Auth-TokenMIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

响应消息

响应参数

参数

参数类型

取值范围

描述

error_code

String

最大长度:16

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

error_msg

String

最大长度:1024

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

details

List<NvlCostAnalysedBillDetail>

最大个数:1000

分摊成本记录数据。

具体请参见表3

total_count

Integer

-

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

currency

String

最大长度:3

货币单位代码:

CNY:人民币

表3 NvlCostAnalysedBillDetail

参数

参数类型

取值范围

描述

shared_month

String

最大长度:20

查询分摊成本的月份。

格式为YYYY-MM,按照东八区截取。

bill_cycle

String

最大长度:20

账期。

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

bill_type

Integer

-

账单类型。

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

customer_id

String

最大长度:64

消费的客户账号ID。

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

region_code

String

最大长度:64

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

region_name

String

最大长度:64

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

service_type_code

String

最大长度:64

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

resource_type_code

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_spec_desc

String

最大长度:512

产品的规格描述。

enterprise_project_id

String

最大长度:128

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

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

enterprise_project_name

String

最大长度:256

企业项目的名称。

charging_mode

nteger

-

计费模式。

  • 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

-

预留实例使用量单位。

consume_amount

BigDecimal

-

消费金额(应付金额)。

消费金额=期初已分摊金额+当月分摊金额+期末未分摊金额

past_months_amortized_amount

BigDecimal

-

期初已分摊金额。

说明:

包周期和预留实例预付时有效;计费类型为按需,预留实例为按时计费时该值为0。

current_month_amortized_amount

BigDecimal

-

当月分摊金额。

当月分摊金额=现金分摊金额+信用额度分摊金额+代金券分摊金额+现金券分摊金额+储值卡分摊金额+奖励金分摊金额

future_months_amortized_amount

BigDecimal

-

期末未分摊金额。月度成本分摊时,当月以后还未分摊的金额。

说明:

包周期和预留实例预付时有效;计费类型为按需,预留实例为按时计费时该值为0。

amortized_cash_amount

BigDecimal

-

月度成本分摊时,当月已分摊金额中包含的现金金额。

amortized_credit_amount

BigDecimal

-

月度成本分摊时,当月已分摊金额中包含的信用额度分摊金额。

amortized_coupon_amount

BigDecimal

-

月度成本分摊时,当月已分摊金额中包含的代金券分摊金额。

amortized_flexipurchase_coupon_amount

BigDecimal

-

月度成本分摊时,当月已分摊金额中包含的现金券分摊金额。

amortized_stored_value_card_amount

BigDecimal

-

月度成本分摊时,当月已分摊金额中包含的储值卡分摊金额。

amortized_bonus_amount

BigDecimal

-

月度成本分摊时,当月已分摊金额中包含的奖励金分摊金额(用于现网未清干净的奖励金)。

响应示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time  
{
    "currency": "CNY",
    "total_count": 1,
    "details": [
          {
            "shared_month": "2021-02",
            "bill_cycle": "2021-02",
            "bill_type": 4,
            "customer_id": "07fe2821e4802f8d0f26c0129657a4a0",
            "region_code": "cn-north-4",
            "region_name": "CN North-Beijing4",
            "service_type_code": "hws.service.type.ebs",
            "resource_type_code": "hws.resource.type.volume",
            "effective_time": "2020-03-12T11:39:52Z",
            "expire_time": "2020-04-12T15:59:59Z",
            "resource_id": "b3caab6a-6669-4bfd-95c0-14fc8457303a",
            "resource_name": "volume-5d41",
            "resource_tag": null,
            "product_spec_desc": null,
            "enterprise_project_id": "0",
            "enterprise_project_name": "default",
            "charging_mode": 1,
            "order_id": "CS2003121943K23TZ",
            "period_type": 20,
            "usage_type": "duration",
            "usage": 0,
            "usage_measure_id": null,
            "free_resource_usage": 0,
            "free_resource_measure_id": null,
            "ri_usage": null,
            "ri_usage_measure_id": null,
            "consume_amount": 3,
            "past_months_amortized_amount": 1.88,
            "current_month_amortized_amount": 1.12,
            "future_months_amortized_amount": 0,
            "amortized_cash_amount": 1.12,
            "amortized_credit_amount": 0,
            "amortized_coupon_amount": 0,
            "amortized_flexipurchase_coupon_amount": 0,
            "amortized_stored_value_card_amount": 0,
            "amortized_bonus_amount": 0
        }
    ]
}

状态码

HTTP状态码

错误码

错误描述

400

CBC.0100

参数错误。

403

CBC.0151

访问拒绝。

500

CBC.0999

未知错误。

分享:

    相关文档

    相关产品