流量包查询

最近更新时间:2024-03-12 01:14:31

我的收藏

1. 接口描述

接口请求域名: cdn.tencentcloudapi.com 。

DescribeTrafficPackages 用于查询 CDN 流量包详情。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTrafficPackages。
Version String 公共参数,本接口取值:2018-06-06。
Region String 公共参数,本接口不需要传递此参数。
Offset Integer 分页查询起始地址,默认 0
示例值:0
Limit Integer 分页查询记录个数,默认100,最大1000
示例值:100
SortBy String 流量包排序方式,支持以下值:
expireTimeDesc:默认值,按过期时间倒序
expireTimeAsc:按过期时间正序
createTimeDesc:按创建时间倒序
createTimeAsc:按创建时间正序
status:按状态排序,正常抵扣>未生效>已用尽>已过期
channel:按来源排序,主动购买>自动续订>CDN赠送
示例值:status

3. 输出参数

参数名称 类型 描述
TotalCount Integer 流量包总个数
示例值:40
TrafficPackages Array of TrafficPackage 流量包详情
ExpiringCount Integer 即将过期的流量包个数(7天内)
示例值:0
EnabledCount Integer 有效流量包个数
示例值:40
PaidCount Integer 付费流量包个数
示例值:20
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询流量包列表

查询流量包列表

输入示例

POST / HTTP/1.1
Host: cdn.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTrafficPackages
<公共请求参数>

{
    "Limit": "1",
    "Offset": "0"
}

输出示例

{
    "Response": {
        "RequestId": "b1a70a67f5500913be355ac2f09ff191",
        "TrafficPackages": [
            {
                "Id": 22890370,
                "Type": "日常流量包",
                "ConfigId": 672,
                "Bytes": 100000000000,
                "BytesUsed": 0,
                "Status": "frozen",
                "CreateTime": "2022-11-11 15:52:28",
                "EnableTime": "2022-11-11 15:00:00",
                "ExpireTime": "2023-11-11 15:00:00",
                "ContractExtension": false,
                "AutoExtension": false,
                "ExtensionMode": 0,
                "Area": "mainland",
                "LifeTimeMonth": 12,
                "RefundAvailable": false,
                "Channel": "ACTIVE_PURCHASE",
                "ExtensionAvailable": false,
                "Region": 0,
                "TrueEnableTime": "2022-11-11 15:00:00",
                "TrueExpireTime": "2023-11-11 15:59:59"
            }
        ],
        "TotalCount": 1,
        "ExpiringCount": 0,
        "EnabledCount": 0,
        "PaidCount": 1
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError.CamSystemError 内部鉴权系统错误。
InternalError.CdnDbError 内部数据错误,请联系腾讯云工程师进一步排查。
InternalError.CdnSystemError 系统错误,请联系腾讯云工程师进一步排查。
InternalError.ProxyServer 内部服务错误,请联系腾讯云工程师进一步排查。
InternalError.RouteError 内部服务错误,请联系腾讯云工程师进一步排查。
InvalidParameter.CdnParamError 参数错误,请参考文档中示例参数填充。
ResourceNotFound.CdnUserNotExists 未开通CDN服务,请开通后使用此接口。
UnauthorizedOperation.CdnCamUnauthorized 子账号未配置cam策略。
UnauthorizedOperation.OperationTooOften 操作超出调用频次限制。