tencent cloud

云点播

动态与公告
产品动态
公告
产品简介
产品概述
产品特性
产品功能
产品优势
应用场景
解决方案
专业版
云点播专业版简介
快速入门
控制台指南
开发指南
购买指南
计费概述
计费方式
购买指引
账单查询
续费说明
欠费说明
退费说明
快速入门
控制台指南
控制台介绍
服务概览
应用管理
媒体管理
资源包管理
License 管理
实时日志分析
实践教程
媒体上传
如何将点播的媒体文件进行智能降冷
媒体处理
分发播放
如何接收事件通知
如何进行源站迁移
直播录制
如何进行自定义源站回源
直播精彩剪辑固化至云点播 VOD 指引
如何使用 EdgeOne 分发云点播内容
开发指南
媒体上传
媒体加工处理
媒体 AI
事件通知
媒体分发播放
媒体加密与版权保护
播放频道
访问管理
下载媒体文件
应用体系
错误码
播放器 SDK 文档
概述
基本概念
产品功能
Demo 体验
免费测试
购买指南
SDK 下载
License 指引
播放器教程
含 UI 集成方案
无 UI 集成方案
高级功能
API 文档
第三方播放器插件
Player SDK Policy
服务端 API 文档
History
Introduction
API Category
Other APIs
Media Processing APIs
Task Management APIs
Media Upload APIs
Media Management APIs
Event Notification Relevant API
Media Categorization APIs
Domain Name Management APIs
Distribution APIs
AI-based Sample Management APIs
Region Management APIs
Data Statistics APIs
Carousel-Related APIs
Just In Time Transcode APIs
No longer recommended APIs
Making API Requests
AI-based image processing APIs
Parameter Template APIs
Task Flow APIs
Data Types
Error Codes
Video on Demand API 2024-07-18
常见问题
移动端播放问题
费用相关问题
视频上传问题
视频发布问题
视频播放问题
Web 端播放问题
全屏播放问题
数据统计问题
访问管理相关问题
媒资降冷问题
相关协议
Service Level Agreement
VOD 政策
隐私政策
数据处理和安全协议
联系我们
词汇表

DescribeCDNStatDetails

PDF
聚焦模式
字号
最后更新时间: 2025-10-30 22:06:59

1. API Description

Domain name for API request: vod.intl.tencentcloudapi.com.

This API is used to query CDN bandwidth, traffic, and other data of VOD domain names.

  • The query period is up to 90 days.
  • You can query data of different service regions.
  • You can query data of Chinese mainland by region and ISP.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeCDNStatDetails.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required.
Metric Yes String Query indicators, the values u200bu200bare:
  • Traffic: traffic, unit is Byte.
  • Bandwidth: Bandwidth, unit is Bps.
  • Requests: Number of requests.
  • QUICRequests: Number of QUIC requests.
  • IpVisit: Number of IP visits.
  • StartTime Yes String Start time in ISO date format.
    EndTime Yes String End time in ISO date format.
    SubAppId No Integer The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    DomainNames.N No Array of String List of domain names. The usage data of up to 20 domain names can be queried at a time. The usage data of all domain names is returned by default.
    Area No String Service region. Valid values:
  • Chinese Mainland
  • Asia Pacific Region 1: Hong Kong (China), Macao (China), Singapore, Vietnam, and Thailand
  • Asia Pacific Region 2: Taiwan (China), Japan, Malaysia, Indonesia, and South Korea
  • Asia Pacific Region 3: Philippines, India, Australia, and other Asia Pacific countries and regions
  • Middle East
  • Europe
  • North America
  • South America
  • Africa

  • Default value: Chinese Mainland
    Districts.N No Array of String District where users are located. When Area is Chinese Mainland, valid values for Districts are as follows. Otherwise, Districts can be ignored.
  • Beijing
  • Inner Mongolia
  • Shanxi
  • Hebei
  • Tianjin
  • Ningxia
  • Shaanxi
  • Gansu
  • Qinghai
  • Xinjiang
  • Heilongjiang
  • Jilin
  • Liaoning
  • Fujian
  • Jiangsu
  • Anhui
  • Shandong
  • Shanghai
  • Zhejiang
  • Henan
  • Hubei
  • Jiangxi
  • Hunan
  • Guizhou
  • Yunnan
  • Chongqing
  • Sichuan
  • Xizang
  • Guangdong
  • Guangxi
  • Hainan
  • Hong Kong, Macao and Taiwan
  • Outside Chinese Mainland
  • Other
  • Isps.N No Array of String ISP of users. When Area is Chinese Mainland, valid values for Isps are as follows. Otherwise, Isps can be ignored.
  • China Telecom
  • China Unicom
  • CERNET
  • Great Wall Broadband Network
  • China Mobile
  • China Mobile Tietong
  • ISPs outside Chinese Mainland
  • Other ISPs
  • DataInterval No Integer Time granularity of every piece of data in minutes. Valid values:
  • 5: 5-minute granularity. The data at 5-minute granularity in the query period will be returned.
  • 1440: 1-day granularity. The data at 1-day granularity in the query period will be returned. If the query period is larger than 24 hours, only data at 1-day granularity can be queried.

  • If the difference between StartTime and EndTime is larger than 24 hours, the default value of DataInterval is 1440.

    3. Output Parameters

    Parameter Name Type Description
    DataInterval Integer Time granularity of every piece of data in minutes.
    Data Array of StatDataItem CDN usage statistics.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Query the traffic data of the domain name 123.vod2.com in mainland China.

    Query the traffic data of the domain name 123.vod2.com in mainland China.

    Input Example

    https://vod.intl.tencentcloudapi.com/?Action=DescribeCDNStatDetails
    &DomainNames.0=123.vod2.myqcloud.com
    &StartTime=2018-12-01T00:00:00+08:00
    &EndTime=2018-12-03T00:00:00+08:00
    &Area=Chinese Mainland
    &Metric=Traffic
    &<Public Request Parameter>

    Output Example

    {
        "Response": {
            "DataInterval": 1440,
            "Data": [
                {
                    "Time": "2018-12-01T00:00:00+08:00",
                    "Value": 1000000
                },
                {
                    "Time": "2018-12-02T00:00:00+08:00",
                    "Value": 1500000
                },
                {
                    "Time": "2018-12-03T00:00:00+08:00",
                    "Value": 1500000
                }
            ],
            "RequestId": "requestId"
        }
    }

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    AuthFailure CAM signature/authentication error.
    FailedOperation Operation failed.
    FailedOperation.InvalidAccount User account exception.
    FailedOperation.InvalidVodUser The VOD service is not activated.
    InternalError.DBError Internal error. Failed to access DB.
    InvalidParameterValue.Area Invalid Area.
    InvalidParameterValue.Districts Incorrect Districts.
    InvalidParameterValue.DomainNames Parameter value. The domain name list is too large.
    InvalidParameterValue.EndTime Incorrect parameter value: invalid EndTime.
    InvalidParameterValue.Isps Invalid Isps.
    InvalidParameterValue.Metric Parameter error: Invalid metric.
    InvalidParameterValue.StartTime Incorrect parameter value: invalid StartTime.

    帮助和支持

    本页内容是否解决了您的问题?

    填写满意度调查问卷,共创更好文档体验。

    文档反馈