tencent cloud

APIs

DocumentaçãoAPIsVideo on DemandData Statistics APIsDescribeCDNStatDetails

DescribeCDNStatDetails

Download
Modo Foco
Tamanho da Fonte
Última atualização: 2026-05-19 15:02:54

1. API Description

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

This API is used to query CDN bandwidth, traffic volume and stats of on-demand domain names.

  • The start time and end time of the query should not exceed a 90-day span.
  • You can query data from different service regions.
    Data support within the Chinese mainland allows querying stats by specified region and carrier.
    Playback statistics only target VOD domains (EdgeOne domain name distribution is not included).

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 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. Use the ISO date format.
    SubAppId No Integer On-demand application ID. Customers who activate on-demand services from December 25, 2023 must fill this field with the app ID when accessing resources in on-demand applications (whether default or newly created).
    DomainNames.N No Array of String Domain name list. Up to 20 domain names can be queried for data. Default returns the overlaid usage data of all domains.
    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, Japan, Malaysia, Indonesia, Korea.
  • Asia Pacific Region 3: Asia Pacific zone 3, including 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 is Chinese mainland.
    Districts.N No Array of String When the user's located region is Chinese Mainland, value is the following region information. When Area has other values, ignore the Districts parameter.
  • 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.
  • Hunan: Hu’nan.
  • 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, value is the following carrier information. When Area is other values, ignore the Isps parameter.
  • China Telecom: CTCC.
  • China Unicom: CUCC.
  • CERNET: China Education Network.
  • Great Wall Broadband Network: Great Wall Broadband.
  • China Mobile: CMCC.
  • 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 minute granularity for the specified query time.
  • 1440: Day granularity. Returns the data of day granularity within the specified query time. The duration between start time and end time is more than 24 hours. Supports only day granularity data.

    • When the duration 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. Measurement 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 the traffic data of domain name example.com in the Chinese mainland.

    Query the traffic data of 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 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.
    Anterior: DescribeStorageDataPróximo: CreateRoundPlay

    Ajuda e Suporte

    Esta página foi útil?

    comentários