tencent cloud

APIs

DokumentasiAPIsVideo on DemandData Statistics APIsDescribeCDNStatDetails

DescribeCDNStatDetails

Unduh
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-09-22 22:25:38

1. API Description

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

This API is used to query CDN bandwidth, traffic, and other stats for a VOD domain.

  • The time span between the query start time and end time should not exceed 90 days.
  • You can query data in different service regions.
  • Statistical data support is available for querying specified regions and carriers within the Chinese mainland.
  • Playback statistics only target VOD domains, excluding EdgeOne domain distribution.

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 Queried metric. Valid values:
  • Traffic: Total Traffic, in bytes.
  • Bandwidth: bandwidth, in Bps.
  • Requests: request count.
  • QUICRequests: number of QUIC requests.
  • IpVisit: number of IP visits.
    		•
    StartTime Yes String Start time. Use the ISO date format.
    EndTime Yes String End time in ISO date format.
    SubAppId No Integer VOD application ID. For customers who activate VOD after December 25, 2023, this field must be set to the app ID when accessing resources in VOD applications (whether the default application or a newly created application).
    DomainNames.N No Array of String Domain name list. Up to 20 domain names can be queried for data at a time. By default, the combined usage data of all domain names is returned.
    Area No String Service area. Valid values:
  • Chinese Mainland: Chinese mainland.
  • Asia Pacific Region 1: Asia Pacific zone 1, including Hong Kong (China), Macao (China), Singapore, Vietnam, and Thailand.
  • Asia Pacific Region 2: Asia Pacific zone 2, including Taiwan (China), Japan, Malaysia, Indonesia, and South Korea.
  • Asia Pacific Region 3: Asia Pacific zone 3, including the Philippines, India, Australia, and other countries and regions in Asia Pacific.
  • Middle East: Middle East.
  • Europe: Europe.
  • North America: North America.
  • South America: South America.
  • Africa: Africa.

    • Default value: Chinese mainland.
    Districts.N No Array of String User's located region. When Area is Chinese Mainland, the value is the following region information. When Area is other values, the Districts parameter is ignored.
  • Beijing: Beijing.
  • Inner Mongolia: Inner Mongolia.
  • Shanxi: Shanxi.
  • Hebei: Hebei.
  • Tianjin: Tianjin.
  • Ningxia: Ningxia.
  • Shaanxi: Shaanxi.
  • Gansu: Gansu.
  • Qinghai: Qinghai.
  • Xinjiang: Xinjiang.
  • Heilongjiang: Heilongjiang.
  • Jilin: Jilin.
  • Liaoning: Liaoning.
  • Fujian: Fujian.
  • Jiangsu: Jiangsu.
  • Anhui: Anhui.
  • Shandong: Shandong.
  • Shanghai: Shanghai.
  • Zhejiang: Zhejiang.
  • Henan: Henan.
  • Hubei: Hubei.
  • Jiangxi: Jiangxi.
  • Hu’nan: Hunan.
  • Guizhou: Guizhou.
  • Yunnan: Yunnan.
  • Chongqing: Chongqing.
  • Sichuan: Sichuan.
  • Xizang: Tibet.
  • Guangdong: Guangdong.
  • Guangxi: Guangxi.
  • Hainan: Hainan.
  • Hong Kong, Macao and Taiwan: Hong Kong (China), Macao (China), and Taiwan (China).
  • Outside Chinese Mainland: overseas.
  • Other: Other.
    		•
    Isps.N No Array of String User's Operator Information. When Area is Chinese Mainland, the value is the following carrier information. When Area is other values, ignore the Isps parameter.
  • China Telecom: China Telecom.
  • China Unicom: China Unicom.
  • CERNET: China Education Network.
  • Great Wall Broadband Network: Great Wall Broadband.
  • China Mobile: China Mobile.
  • China Mobile Tietong: China Tietong.
  • ISPs outside Chinese Mainland: overseas carriers.
  • Other ISPs: other ISPs.
    		•
    DataInterval No Integer Time granularity of each data entry. Unit: minute. Valid values:
  • 5: 5 minutes. Return detailed data at a 5-minute granularity within the specified query time.
  • 1440: day granularity, returns data at 1-day granularity within the specified query time. If the duration between the start time and end time is more than 24 hours, only day granularity data is supported.

    • When the time span between StartTime and EndTime is more than 24 hours, DataInterval defaults to 1440.

    3. Output Parameters

    Parameter Name Type Description
    DataInterval Integer Time granularity of each data entry. Unit: minute.
    Data Array of StatDataItem CDN usage data.
    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 traffic data of domain name example.com in Chinese mainland.

    Query traffic data of the domain name example.com in the Chinese mainland.

    Input Example

    https://vod.intl.tencentcloudapi.com/?Action=DescribeCDNStatDetails
&DomainNames.0=example.com
&StartTime=2018-12-01T00:00:00+08:00
&EndTime=2018-12-03T00:00:00+08:00
&Area=Chinese Mainland
&Metric=Traffic
&<Common request parameters>

    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 enabled.
    InternalError.DBError Internal error. Failed to access the DB.
    InvalidParameterValue.Area Area parameter error.
    InvalidParameterValue.Districts District parameter value error.
    InvalidParameterValue.DomainNames Parameter value error: The domain name list is too large.
    InvalidParameterValue.EndTime Invalid parameter value: EndTime is invalid.
    InvalidParameterValue.Isps Invalid Isps parameter.
    InvalidParameterValue.Metric Parameter error: Metric is invalid.
    InvalidParameterValue.StartTime Invalid parameter value: StartTime is invalid.
    Topik sebelumnya: DescribeStorageDataTopik selanjutnya: CreateRoundPlay

    Bantuan dan Dukungan

    Apakah halaman ini membantu?

    masukan

    Search
      Enter keywords to search documentation