API 文档

中国境内流量包查询

最近更新时间:2020-11-30 08:12:00

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
Limit Integer 分页查询记录个数,默认100,最大1000

3. 输出参数

参数名称 类型 描述
TotalCount Integer 流量包总个数
TrafficPackages Array of TrafficPackage 流量包详情
ExpiringCount Integer 即将过期的流量包个数(7天内)
EnabledCount Integer 有效流量包个数
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 境内流量包查询

输入示例

https://cdn.tencentcloudapi.com/?Action=DescribeTrafficPackages
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "bc7df980-c745-4f80-854e-1a49295b0d5f",
    "TrafficPackages": [
      {
        "Id": 123,
        "Type": "新手流量包",
        "Bytes": 50000000000,
        "BytesUsed": 0,
        "Status": "expired",
        "CreateTime": "2017-07-31 09:28:14",
        "EnableTime": "2017-07-01 00:00:00",
        "ExpireTime": "2017-08-01 00:00:00",
        "ContractExtension": false,
        "AutoExtension": false,
        "Channel": "cdn",
        "Area": "mainland",
        "LifeTimeMonth": 1,
        "ExtensionAvailable": false
      }
    ],
    "TotalCount": 40,
    "ExpiringCount": 0,
    "EnabledCount": 40
  }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.CdnDbError 内部数据错误,请联系腾讯云工程师进一步排查。
InternalError.CdnSystemError 系统错误,请联系腾讯云工程师进一步排查。
InvalidParameter.CdnParamError 参数错误,请参考文档中示例参数填充。
ResourceNotFound.CdnUserNotExists 未开通CDN服务,请开通后使用此接口。
UnauthorizedOperation.CdnCamUnauthorized 子账号未配置cam策略。
目录