流量包用量查询

最近更新时间:2018-11-08 09:50:23

接口描述

本接口用于查询账号下 CDN(大陆)流量包使用情况。
接口请求域名:cdn.api.qcloud.com
接口名:GetPackage

查看 调用示例

输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,详情请参见 公共请求参数页面。其中,此接口的 Action 字段为 GetPackage。

输出参数

参数 类型 描述
code Int 公共错误码,0 表示成功,其他值表示失败
详情请参见错误码页面的 公共错误码
message String 模块错误信息描述,与接口相关
codeDesc String 英文错误信息,或业务侧错误码
data String 流量包使用明细,详情请见下文

data

参数 类型 描述
id Int 流量包 ID
flux_title String 流量包名称
flux_byte Int 流量包总量,单位:Byte
flux_used Int 已抵扣流量包用量,单位:Byte
create_time String 流量包生成时间
enable_time String 流量包有效期起始时间
expire_time String 流量包有效期截止时间
is_enable bool 是否有效
true:有效
false:无效
is_expire bool 是否过期
true:已过期
false:未过期
有效的流量包过期后,不可进行抵扣

代码示例

GET 请求

GET 请求需要将所有参数都加在 URL 后(逗号进行转码):

https://cdn.api.qcloud.com/v2/index.php?
Action=GetPackage
&SecretId=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
&Timestamp=1522399440
&Nonce=123456789
&Signature=XXXXXXXXXXXXXXXXXXXXX

POST 请求

POST 请求时,参数填充在 HTTP Requestbody 中,请求地址:

https://cdn.api.qcloud.com/v2/index.php

参数支持 form-data 等格式,参数数组如下:

array (
    'Action' => 'GetPackage',
    'SecretId' => 'XXXXXXXXXXXXXXXXXXXXXXXXXXXX',
    'Timestamp' => 1522399440,
    'Nonce' => 123456789,
    'Signature' => 'XXXXXXXXXXXXXXXXXXXXXXXX'
)

返回示例

{
    "code": 0,
    "data": [
        {
            "id": 432932,
            "flux_title": "50GB",
            "flux_byte": 50000000000,
            "create_time": "2017-07-01 00:00:00",
            "enable_time": "2017-07-01 00:00:00",
            "expire_time": "2017-08-01 00:00:00",
            "flux_used": 10000,
            "is_enable": true,
            "is_expire": false
        }
    ],
    "message": "",
    "codeDesc": "Success"
}