# 查询资源包使用明细-ListFreeResourcesUsageRecords #### 功能介绍 客户在自建平台查询资源包使用明细。 #### 接口约束 该接口只允许客户的AK/SK或者Token调用。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=BSS&api=ListFreeResourcesUsageRecords)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[策略授权参考](https://support.huaweicloud.com/api-oce/jac_000053.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 描述 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | |:---|:---|:---|:---|:---|:---| | billing:resourcePackages:view | 授予查看资源包，剩余量汇总，使用明细查询/导出的权限 | list | - | - | - | #### URI GET /v2/bills/customer-bills/free-resources-usage-records 表1查询参数 | 参数 | 是否必选 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---|:---| | free_resource_id | 否 | String | 最大长度：64 | 资源项ID，一个资源包中会含有多个资源项，一个使用量类型对应一个资源项。资源项ID来自[查询资源包列表](https://support.huaweicloud.com/api-oce/api_order_00027.html)接口的响应。 此参数不携带或携带值为空时，不作为筛选条件。 | | product_id | 否 | String | 最大长度：64 | 产品ID，即资源包ID。 此参数不携带或携带值为空时，不作为筛选条件。 | | resource_type_code | 否 | String | 最大长度：64 | 资源类型编码，例如ECS的VM为"hws.resource.type.vm"。您可以调用[查询资源类型列表-ListResourceTypes](https://support.huaweicloud.com/api-oce/zh-cn_topic_0000001256519451.html)接口获取。 此参数不携带或携带值为空时，不作为筛选条件。 | | deduct_time_begin | 是 | String | 最大长度：10 | 资源抵扣的起始时间。东八区时间，格式为YYYY-MM-DD。 | | deduct_time_end | 是 | String | 最大长度：10 | 资源抵扣的结束时间。东八区时间，格式为YYYY-MM-DD。 说明： 抵扣结束时间-抵扣起始时间\<=90天。 | | 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。 | #### 请求消息 **请求参数** 无。 **请求示例** ``` GET https://bss.myhuaweicloud.com/v2/bills/customer-bills/free-resources-usage-records?free_resource_id=free_resource_id&product_id=product_id&resource_type_code=resource_type_code&deduct_time_begin=2021-10-01&deduct_time_end=2021-10-31&offset=0&limit=10 HTTP/1.1 Content-Type: application/json X-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ ``` #### 响应消息 **响应参数** | 参数 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---| | error_code | String | 20 | 状态码。 具体请参考[状态码]。只有失败才返回该字段。 | | error_msg | String | 1000 | 错误描述信息。 只有失败才返回该字段。 | | free_resource_records | List\ | 最大个数：1000 | 资源包使用明细记录，具体参见[表2]。 | | total_count | Integer | - | 满足条件的总个数。 | 表2FreeResourceRecord | 参数 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---| | deduct_time | String | 最大长度：20 | 资源抵扣时间。 UTC时间，格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如"2021-10-13T10:01:49Z"。 | | free_resource_id | String | 最大长度：64 | 资源项ID，一个资源包中会含有多个资源项，一个使用量类型对应一个资源项。 | | resource_id | String | 最大长度：64 | 资源ID。 | | resource_type_code | String | 最大长度：64 | 资源类型编码。例如ECS的VM为"hws.resource.type.vm"。 | | resource_type_name | String | 最大长度：200 | 资源类型名称。例如ECS的资源类型名称为"云主机"。 | | resource_tag | String | 最大长度：10240 | 资源标签。 | | product_id | String | 最大长度：64 | 产品ID，即资源包ID。 | | product_name | String | 最大长度：256 | 产品名称，即资源包名称。 | | usage_type_code | String | 最大长度：64 | 使用量类型。 | | available_amount | String | 最大长度：64 | 资源抵扣前余量。 | | remaining_amount | String | 最大长度：64 | 资源抵扣后余量。 | | used_amount | String | 最大长度：64 | 抵扣量。 | | measure_id | Integer | - | 度量单位，免费资源套餐额度度量单位。您可以调用[查询度量单位列表-ListMeasureUnits](https://support.huaweicloud.com/api-oce/qct_00006.html)接口获取。 | | effective_time | String | 最大长度：20 | 资源使用的开始时间，UTC时间。 | | expire_time | String | 最大长度：20 | 资源使用的结束时间，UTC时间。 | **响应示例** ``` HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Content-Length: length Date: response time { "free_resource_records": [ { "deduct_time": "2021-10-19T08:04:25Z", "free_resource_id": "43248428-8409-47cd-b115-6a5872e2200b", "resource_id": "resourceInstanceId_north1_obs_10120001112", "resource_type_code": "", "resource_tag": "--", "product_id": "90301-247012-0--0", "product_name": "OBS存储包 10TB 包月 北京7", "usage_type_code": "", "available_amount": "10190", "remaining_amount": "10140", "used_amount": "50", "measure_id": 10, "effective_time": "2021-10-13T10:01:49Z", "expire_time": "2021-10-13T11:00:00Z" } ], "total_count": 1 } ``` #### 状态码 ![](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 | 其他错误。 |