# 查询月度成本-ListCustomerBillsMonthlyBreakDown #### 功能介绍 客户可以查询指定月份的月度摊销成本。当前仅支持查询近18个月的摊销成本。摊销成本计算规则请参见[成本摊销规则](https://support.huaweicloud.com/usermanual-cost/costcenter_000002_01.html)。 客户可查询的数据范围同成本中心提供的[数据范围](https://support.huaweicloud.com/usermanual-cost/costcenter_0000004.html)一致。 客户登录成本中心导出成本明细请参见[导出成本明细数据](https://support.huaweicloud.com/usermanual-cost/costcenter_000002_03.html)。 #### 接口约束 该接口只允许使用客户AK/SK或者Token调用。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=BSS&api=ListCustomerBillsMonthlyBreakDown)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[策略授权参考](https://support.huaweicloud.com/api-oce/jac_000053.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 描述 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | |:---|:---|:---|:---|:---|:---| | costCenter:costDetail:listCostDetails | 授予查询成本明细的权限。 | read | - | - | - | #### URI GET /v2/costs/cost-analysed-bills/monthly-breakdown URL参数说明请参见下表。 表1消息头参数 | 参数 | 是否必选 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---|:---| | X-Language | 否 | String | 最大长度：10 | 语言。 - zh_CN：中文 - en_US：英文 缺省为zh_CN。 | 表2查询参数 | 参数 | 是否必选 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---|:---| | shared_month | 是 | String | 最大长度：10 | 查询分摊成本的月份，东八区时间，格式：YYYY-MM。 | | charging_mode | 否 | Integer | \[1-11\] | 计费模式。 - 1：包年/包月 - 3：按需 - 11：节省计划 此参数不携带或携带值为空时，不作为筛选条件。 | | service_type_code | 否 | String | 最大长度：64 | 云服务类型编码，例如OBS的云服务类型编码为"hws.service.type.obs"。您可以调用[查询云服务类型列表-ListServiceTypes](https://support.huaweicloud.com/api-oce/zh-cn_topic_0000001256679455.html)接口获取。 此参数不携带或携带值为空时，不作为筛选条件；携带值为空串时，作为筛选条件。 | | resource_type_code | 否 | String | 最大长度：64 | 资源类型编码，例如ECS的VM为"hws.resource.type.vm"。您可以调用[查询资源类型列表-ListResourceTypes](https://support.huaweicloud.com/api-oce/zh-cn_topic_0000001256519451.html)接口获取。 此参数不携带或携带值为空时，不作为筛选条件；携带值为空串时，作为筛选条件。 | | region_code | 否 | String | 最大长度：64 | 云服务区编码，例如："cn-north-1"。具体请参见[地区和终端节点](https://developer.huaweicloud.com/endpoint)对应云服务的"区域"列的值。 此参数不携带或携带值为空时，不作为筛选条件。 | | bill_type | 否 | Integer | - | 账单类型。 - 1：消费-新购 - 2：消费-续订 - 3：消费-变更 - 4：退款-退订 - 5：消费-使用 - 8：消费-自动续订 - 9：调账-补偿 - 14：消费-服务支持计划月末扣费 - 16：调账-扣费 - 18：消费-按月付费 - 20：退款-变更 - 23：消费-节省计划抵扣 - 24：退款-包年/包月转按需 - 25：消费-抹零补扣 - 103：消费-按年付费 此参数不携带或携带值为空时，不作为筛选条件。 | | 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。 此参数不携带或携带值为空时，不作为筛选条件。 | | resource_name | 否 | String | 最大长度：64 | 资源名称。 此参数不携带或携带值为空时，不作为筛选条件。 | | enterprise_project_id | 否 | String | 最大长度：64 | 企业项目标识（企业项目ID）。 - default项目对应ID：0 - 未归集（表示该云服务不支持企业项目管理能力）项目对应ID：-1或null或空串 - 其余项目对应ID获取方法请参见[如何获取企业项目ID](https://support.huaweicloud.com/usermanual-em/zh-cn_topic_0126101490.html)。 此参数不携带或携带值为空时，不作为筛选条件。 | | 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®ion_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-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ ``` #### 响应消息 **响应参数** | 参数 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---| | error_code | String | 最大长度：16 | 状态码。具体请参考[状态码]。只有失败才会返回这个参数。 | | error_msg | String | 最大长度：1024 | 错误描述信息。只有失败才会返回这个参数。 | | details | List\ | 最大个数：1000 | 分摊成本记录数据。 具体请参见[表3]。 | | total_count | Integer | - | 结果集数量，只有成功才返回这个参数。 | | currency | String | 最大长度：3 | 货币单位代码： CNY：人民币 | 表3NvlCostAnalysedBillDetail | 参数 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---| | shared_month | String | 最大长度：20 | 查询分摊成本的月份。 格式为YYYY-MM，按照东八区时间截取。 | | bill_cycle | String | 最大长度：20 | 账期。 格式：YYYY-MM。按照东八区时间截取。 | | bill_type | Integer | - | 账单类型。 - 1：消费-新购 - 2：消费-续订 - 3：消费-变更 - 4：退款-退订 - 5：消费-使用 - 8：消费-自动续订 - 9：调账-补偿 - 14：消费-服务支持计划月末扣费 - 16：调账-扣费 - 18：消费-按月付费 - 20：退款-变更 - 23：消费-节省计划抵扣 - 24：退款-包年/包月转按需 - 25：消费-抹零补扣 - 103：消费-按年付费 | | customer_id | String | 最大长度：64 | 消费的客户账号ID。 - 如果是普通客户或者企业子查询消费记录，只能查询到自身的消费记录，则这个地方显示的是自身的客户ID。 - 如果是企业主查询消费记录，可以查询到自身以及企业子的消费记录，这个地方是消费的实际客户ID，如果是企业主自身消费，为企业主ID，如果这条消费记录是某个企业子客户的消费，这个地方的ID是企业子账号ID。 | | region_code | String | 最大长度：64 | 云服务区编码，例如："cn-north-1"。具体请参见[地区和终端节点](https://developer.huaweicloud.com/endpoint)对应云服务的"区域"列的值。 | | region_name | String | 最大长度：64 | 云服务区名称，例如："华北-北京"。具体请参见[地区和终端节点](https://developer.huaweicloud.com/endpoint)对应云服务的"区域名称"列的值。 | | service_type_code | String | 最大长度：64 | 云服务类型编码，例如OBS的云服务类型编码为"hws.service.type.obs"。 | | resource_type_code | String | 最大长度：64 | 资源类型编码，例如ECS的VM为"hws.resource.type.vm"。 | | service_type_name | String | 最大长度：200 | 云服务类型名称。例如ECS的云服务类型名称为"弹性云服务器"。 | | resource_type_name | String | 最大长度：200 | 资源类型名称。例如ECS的资源类型名称为"云主机"。 | | 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 | 最大长度：64 | 企业项目标识（企业项目ID）。 - default项目对应ID：0 - 未归集（表示该云服务不支持企业项目管理能力）项目对应ID：-1或null或空串 - 其余项目对应ID获取方法请参见[如何获取企业项目ID](https://support.huaweicloud.com/usermanual-em/zh-cn_topic_0126101490.html)。 | | enterprise_project_name | String | 最大长度：256 | 企业项目的名称。 | | charging_mode | Integer | - | 计费模式。 - 1：包年/包月 - 3：按需 - 10：预留实例 - 11：节省计划 | | order_id | String | 最大长度：64 | 订单ID。 说明： 包年/包月资源的使用记录才有该字段，按需资源则为空。 | | period_type | Integer | - | 周期类型。 - 19：年 - 20：月 - 24：天 - 25：小时 - 5：一次性 | | usage_type | String | - | 资源使用量的类型，您可以调用[查询使用量类型列表-ListUsageTypes](https://support.huaweicloud.com/api-oce/qct_00004.html)接口获取。 | | usage | BigDecimal | - | 资源的使用量。 | | usage_measure_id | Integer | - | 资源使用量的度量单位，您可以调用[查询度量单位列表-ListMeasureUnits](https://support.huaweicloud.com/api-oce/qct_00006.html)接口获取。 | | free_resource_usage | BigDecimal | - | 套餐内使用量。 | | free_resource_measure_id | Integer | - | 套餐内使用量的度量单位，您可以调用[查询度量单位列表-ListMeasureUnits](https://support.huaweicloud.com/api-oce/qct_00006.html)接口获取。 | | 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 | - | 月度成本分摊时，当月已分摊金额中包含的奖励金分摊金额（用于现网未清干净的奖励金）。 | | 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 | 整机的子云服务的自身的资源名称，资源标识。（如果为预留实例，则为预留实例标识） | | effective_tag_pairs | List\ | - | 成本标签。 具体请参见[表4]。 | | cost_unit_pairs | List\ | - | 成本分组。 具体请参见[表5]。 | 表4TagPair | 参数 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---| | tag_key | String | 最大长度：128 | 标签key。 | | tag_value | String | 最大长度：256 | 标签value。 | 表5CostUnitPair | 参数 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---| | cost_unit_name | String | 最大长度：128 | 成本分组名称。 | | cost_unit_rule_value | String | 最大长度：256 | 成本分组规则值。 | **响应示例** ``` 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": "07fe28********8d0f26c0129657a4a0", "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-14fc****303a", "resource_name": "volume-5d41", "resource_tag": null, "product_spec_desc": null, "enterprise_project_id": "0", "enterprise_project_name": "default", "charging_mode": 1, "order_id": "CS2003********3TZ", "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, "sub_service_type_code": null, "sub_service_type_name": null, "sub_resource_type_code": null, "sub_resource_type_name": null, "sub_resource_id": null, "sub_resource_name": null, "amortized_bonus_amount": 0, "effective_tag_pairs": [{ "tag_key": "Department", "tag_value": "mobile" }], "cost_unit_pairs": [{ "cost_unit_name": "TEST项目", "cost_unit_rule_value": "HWCloud" }] }] } ``` #### 状态码 ![](https://support.huaweicloud.com/api-oce/public_sys-resources/note_3.0-zh-cn.png) - 状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。 - 状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。 | HTTP状态码 | 错误码 | 错误描述 | |:---|:---|:---| | 400 | CBC.0100 | 参数错误。 | | 400 | CBC.18000014 | 未开通成本中心。 | | 403 | CBC.0151 | 访问拒绝。 | | 500 | CBC.0999 | 未知错误。 | | 400 | CBC.18000048 | 您名下的财务独立子，超过系统可支持查询的数量，请指定企业子账号查询。 说明： 企业主调用查询所有企业子时，最大支持1000个财务独立企业子数量查询，超出需要指定企业子账号查询。 |