链接复制成功!
查询资源包使用量
功能介绍
客户在伙伴销售平台根据资源项维度查询客户的资源包使用量。
接口约束
该接口只允许使用客户AK/SK或者Token调用,不允许使用解决方案提供商或华为云总经销商(一级经销商)的AK/SK或者Token调用。
资源包失效时间超过18个月则无法查询其信息。
调试
您可以在API Explorer中调试该接口。
URI
POST /v2/payments/free-resources/usages/details/query
参数 |
是否必选 |
描述 |
---|---|---|
X-Language |
否 |
参数解释: 语言。 约束限制: 不涉及 取值范围:
默认取值: zh_CN。 |
请求消息
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
free_resource_ids |
是 |
List<string> |
参数解释: 资源项ID列表,每个最大64字节。 资源项ID,一个资源包中会含有多个资源项,一个使用量类型对应一个资源项。资源项ID来自查询资源包列表接口的响应。 约束限制: 不涉及 取值范围: [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<FreeResourceDetail> |
参数解释: 资源套餐内的资源项信息(资源项ID级的详情),具体参见表2。 |
参数 |
参数类型 |
描述 |
---|---|---|
free_resource_id |
String |
参数解释: 资源项ID,一个资源包中会含有多个资源项,一个使用量类型对应一个资源项。 若资源存在暂未生效的续费资源,此处返回的是当前生效的资源ID。 取值范围: 最大长度:64 |
free_resource_type_name |
String |
参数解释: 资源项类型名称。 |
quota_reuse_cycle |
Integer |
参数解释: 重置周期,只有quota_reuse_mode为可重置,该字段才有意义。
|
quota_reuse_cycle_type |
Integer |
参数解释: 重置周期类别,只有quota_reuse_mode为可重置,该字段才有意义。 |
usage_type_name |
String |
参数解释: 使用量类型名称。 |
start_time |
String |
参数解释: 开始时间,格式UTC。
取值范围: 不涉及 |
end_time |
String |
参数解释: 结束时间,格式UTC。
|
amount |
BigDecimal |
参数解释: 资源剩余额度,针对可重置资源包,是指当前重置周期内的剩余量。 |
original_amount |
BigDecimal |
参数解释: 资源原始额度,针对可重置资源包,是指每个重置周期内的总量。 |
measure_id |
Integer |
参数解释: 度量单位,免费资源套餐额度度量单位。您可以调用查询度量单位列表接口获取。 |
响应示例
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
}
]
}