tencent cloud



最后更新时间:2022-08-23 16:02:46

1. API Description

Domain name for API request: vod.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 for this API.
Metric Yes String Metrics to query. Valid values:
  • Traffic: traffic in bytes
  • Bandwidth: bandwidth in bps
  • Requests: the number of requests
  • StartTime Yes String Start time in ISO date format.
    EndTime Yes String End time in ISO date format.
    SubAppId No Integer The VOD subapplication ID. If you need to access a resource in a subapplication, set this parameter to the subapplication ID; otherwise, leave it empty.
    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
  • Tibet
  • 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
  • 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, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying traffic statistics of the domain name 123.vod2.com in the Chinese mainland

    Input Example

    &Area=Chinese Mainland
    &<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


    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 Invalid Metric.
    InvalidParameterValue.StartTime Incorrect parameter value: invalid StartTime.




    7x24 电话支持