# 查询资源包使用量-ListFreeResourceUsages #### 功能介绍 客户在自建平台根据资源项维度查询资源包使用量。 客户登录费用中心进入"[资源包](https://account.huaweicloud.com/usercenter/?locale=zh-cn#/userindex/myResourcePackage)"页面，选择"资源包列表"页签，单击资源包名称可查询资源包使用量。 #### 接口约束 该接口只允许客户的AK/SK或者Token调用。 ![](https://support.huaweicloud.com/api-oce/public_sys-resources/caution_3.0-zh-cn.png) 资源包失效时间超过18个月则无法查询其信息。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=BSS&api=ListFreeResourceUsages)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[策略授权参考](https://support.huaweicloud.com/api-oce/jac_000053.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 描述 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | |:---|:---|:---|:---|:---|:---| | billing:resourcePackages:view | 授予查看资源包，剩余量汇总，使用明细查询/导出的权限 | list | - | - | - | #### URI POST /v2/payments/free-resources/usages/details/query 表1Header参数 | 参数 | 是否必选 | 描述 | |:---|:---|:---| | X-Language | 否 | **参数解释：** 语言。 **约束限制：** 不涉及 **取值范围：** - 中文：zh_CN - 英文：en_US **默认取值：** zh_CN。 | #### 请求消息 **请求参数** | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | free_resource_ids | 是 | List\ | **参数解释：** 资源项ID列表，每个最大64字节。 资源项ID，一个资源包中会含有多个资源项，一个使用量类型对应一个资源项。资源项ID来自[查询资源包列表](https://support.huaweicloud.com/api-oce/api_order_00027.html)接口的响应。 **约束限制：** 不涉及 **取值范围：** \[1-100\] **默认取值：** 不涉及 | **请求示例** ``` POST https://bss.myhuaweicloud.com/v2/payments/free-resources/usages/details/query HTTP/1.1 Content-Type: application/json X-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ { "free_resource_ids": [ "d4463497-991b-439d-9ab6-23f9ed197fe9" ] } ``` #### 响应消息 **响应参数** | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 状态码。具体请参考[状态码]。只有失败才返回该字段。 | | error_msg | String | **参数解释：** 错误描述信息。只有失败才返回该字段。 | | free_resources | List\ | **参数解释：** 资源套餐内的资源项信息（资源项ID级的详情），具体参见[表2](https://support.huaweicloud.com/api-oce/api_order_00028.html#api_order_00028__table4513616143617)。 | 表2FreeResourceDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | free_resource_id | String | **参数解释：** 资源项ID，一个资源包中会含有多个资源项，一个使用量类型对应一个资源项。 说明： 若资源存在暂未生效的续费资源，此处返回的是当前生效的资源ID。 **取值范围：** 最大长度：64 | | free_resource_type_name | String | **参数解释：** 资源项类型名称。 | | quota_reuse_cycle | Integer | **参数解释：** 重置周期，只有quota_reuse_mode为可重置，该字段才有意义。 - 1：小时 - 2：天 - 3：周 - 4：月 - 5：年 | | quota_reuse_cycle_type | Integer | **参数解释** **：** 重置周期类别，只有quota_reuse_mode为可重置，该字段才有意义。 - 1：按自然周期重置 是指重置周期是按照自然月/年来重置，例如如果周期是月，按自然周期重置，表示每个月的1号重置。 - 2：按订购周期重置。 是指重置周期是按照订购时间来重置，例如如果周期是月，按订购周期重置，15号订购了该套餐，表示每个月的15号重置。 | | usage_type_name | String | **参数解释** **：** 使用量类型名称。 | | start_time | String | **参数解释** **：** 开始时间，格式UTC。 - 如果quota_reuse_mode为可重置，则此时间为当前时间所在的重置周期的开始时间。 - 如果quota_reuse_mode为不可重置，则此时间为订购实例的生效时间。 **取值范围：** 不涉及 | | end_time | String | **参数解释** **：** 结束时间，格式UTC。 - 如果quota_reuse_mode为可重置，则此时间为当前时间所在的重置周期的结束时间。 - 如果quota_reuse_mode为不可重置，则此时间为订购实例的失效时间。 | | amount | BigDecimal | **参数解释** **：** 资源剩余额度，针对可重置资源包，是指当前重置周期内的剩余量。 | | original_amount | BigDecimal | **参数解释** **：** 资源原始额度，针对可重置资源包，是指每个重置周期内的总量。 | | measure_id | Integer | **参数解释** **：** 度量单位，免费资源套餐额度度量单位。您可以调用[查询度量单位列表-ListMeasureUnits](https://support.huaweicloud.com/api-oce/qct_00006.html)接口获取。 | **响应示例** ``` HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Content-Length: length Date: response time { "free_resources": [ { "free_resource_id": "d4463497-991b-439d-9ab6-23f9ed197fe9", "free_resource_type_name": "test1", "quota_reuse_cycle": 4, "quota_reuse_cycle_type": 1, "usage_type_name": "时长", "start_time": "2021-04-30T03:30:56Z", "end_time": "2021-05-31T15:59:59Z", "amount": 100, "original_amount": 100, "measure_id": 37 } ] } ``` #### 状态码 ![](https://support.huaweicloud.com/api-oce/public_sys-resources/note_3.0-zh-cn.png) - 状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。 - 状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。 | HTTP状态码 | 错误码 | 错误描述 | |:---|:---|:---| | 400 | CBC.0100 | 参数错误。 | | 403 | CBC.0151 | 访问拒绝。 | | 500 | CBC.0999 | 其他错误。 |