文档首页/ 客户运营能力/ API参考/ 待下线接口/ 管理交易/ 管理资源包/ 查询套餐内使用量（旧）
更新时间：2024-09-24 GMT+08:00
查看PDF
分享

查询套餐内使用量（旧）

功能介绍

客户在自建平台查询套餐内的使用量。

该接口即将下线，“查询套餐内使用量”新接口请参考查询资源包列表和查询资源包使用量。

接口约束

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

URI

POST /v2/payments/free-resources/usages/query

表1 Header参数

参数

是否必选

取值范围

描述

X-Language

否

最大长度：8

语言。

  • 中文：zh_CN
  • 英文：en_US

此字段不携带或携带值为空时，取值为en_US；不支持携带值为空串或携带值为null。

请求消息

请求参数

无

请求示例

POST https://bss.myhuaweicloud.com/v2/payments/free-resources/usages/query HTTP/1.1
Content-Type: application/json
X-Auth-Token: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

响应消息

响应参数

参数

参数类型

取值范围

描述

error_code

String

最大长度：20

状态码。具体请参考状态码。只有失败才返回该字段。

error_msg

String

最大长度：1000

错误描述信息。只有失败才返回该字段。

package_usage_infos

list<PackageUsageInfo>

-

套餐包使用量信息，具体请参见表2。
表2 PackageUsageInfo

参数

参数类型

取值范围

描述

order_instance_id

String

最大长度：255

订购资源包产品后，系统生成的ID，是这个资源包列表的标识字段。

resource_type_name

String

最大长度：255

资源类型名称。

quota_reuse_mode

Integer

-

使用模式。

  • 1：可重置

    表示购买的按需资源包能够按照一定的周期恢复使用量。例如购买一个1年的按需资源包，使用量是40G，可重置，重置周期为1个月，表示1年内每个月会给予40G的使用量。

  • 2：不可重置

    表示购买的按需套餐包的使用量不会恢复。例如购买一个1年的按需资源包，使用量是40G，不可重置，表示1年内一共给予40G的使用量。

quota_reuse_cycle

Integer

-

重置周期，只有quota_reuse_mode为可重置，该字段才有意义。

  • 1：小时
  • 2：天
  • 3：周
  • 4：月
  • 5：年

quota_reuse_cycle_type

Integer

-

重置周期类别，只有quota_reuse_mode为可重置，该字段才有意义。

当quota_reuse_mode为可重置，quota_reuse_cycle_type字段值为null时，默认按自然周期重置。

  • 1：按自然周期重置

    是指重置周期是按照自然月/年来重置，例如如果周期是月，按自然周期重置，表示每个月的1号重置。

  • 2：按订购周期重置。

    是指重置周期是按照订购时间来重置，例如如果周期是月，按订购周期重置，15号订购了该套餐，表示每个月的15号重置。

start_time

String

最大长度：64

开始时间，格式UTC。

  • 如果quota_reuse_mode为可重置，则此时间为当前时间所在的重置周期的开始时间。
  • 如果quota_reuse_mode为不可重置，则此时间为订购实例的生效时间。

end_time

String

最大长度：64

结束时间，格式UTC。

  • 如果quota_reuse_mode为可重置，则此时间为当前时间所在的重置周期的结束时间。
  • 如果quota_reuse_mode为不可重置，则此时间为订购实例的失效时间。

balance

Number

-

套餐包内资源剩余量。

total

Number

-

套餐包的资源总量。

measurement_name

String

最大长度：255

套餐包资源的度量单位名称。

region_code

String

最大长度：255

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

响应示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time 
{
    "package_usage_infos": [
        {
            "order_instance_id": "01154-119701448-0",
            "resource_type_name": "cdn.cdn.flow",
            "quota_reuse_mode": 1,
            "quota_reuse_cycle": 1,
            "quota_reuse_cycle_type": 1,
            "start_time": "2019-12-26T02:00:00Z",
            "end_time": "2019-12-26T02:24:11Z",
            "balance": 100,
            "total": 100,
            "measurement_name": "Byte",
            "region_code": "global-cbc-1"
        }   ]
}

状态码

  • 状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。
  • 状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。

HTTP状态码

错误码

错误描述

500

CBC.0999

其他错误。
父主题： 管理资源包

相关文档