DescribeCDNUsageData

Last updated: 2020-03-27 18:45:27

1. API Description

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

This API is used to query the CDN statistics of VOD such as traffic and bandwidth.

  1. Only CDN usage data for the last 365 days can be queried.
  2. The query time range cannot be more than 90 days.
  3. The time granularity of usage data can be specified, including 5-minute, 1-hour, and 1-day.
  4. Traffic refers to the total traffic within the query time granularity, while bandwidth the peak bandwidth.

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

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 parameter. The value used for this API: DescribeCDNUsageData.
Version Yes String Common parameter. The value used for this API: 2018-07-17.
Region No String Common parameter. This parameter is not required for this API.
StartTime Yes String Start date in ISO date format.
EndTime Yes String End date in ISO date format. The end date must be after the start date.
DataType Yes String CDN statistics type. Valid values:
  • Flux: traffic in bytes.
  • Bandwidth: bandwidth in bps.
  • DataInterval No Integer Time granularity of usage data in minutes. Valid values:
  • 5: 5-minute granularity, which returns the details at the 5-minute granularity within the specified time range.
  • 60: 1-hour granularity, which returns the details at the 1-hour granularity within the specified time range.
  • 1440: 1-day granularity, which returns the details at the 1-day granularity within the specified time range.

  • Default value: 1440. Data at the 1-day granularity will be returned.
    When the value of this field is 1, the total usage of all subapplications (including primary application) are queried by an admin.
    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. You can specify multiple domain names and query their combined usage data. The usage data of all domain names will be returned by default.
    SubAppId No Integer ID of a subapplication in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty.
    When the value of this field is 1, the total usage of all subapplications (including primary application) are queried by an admin. In this case, only 1-day granularity is supported.

    3. Output Parameters

    Parameter Name Type Description
    DataInterval Integer Time granularity in minutes.
    Data Array of StatDataItem CDN statistics.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying CDN traffic statistics of VOD

    This example shows you how to query the CDN traffic statistics between December 1, 2018 (inclusive) and December 3, 2018 (inclusive).

    Input Example

    https://vod.tencentcloudapi.com/?Action=DescribeCDNUsageData
    &StartTime=2018-12-01T00:00:00+08:00
    &EndTime=2018-12-03T00:00:00+08:00
    &DataType=Flux
    &<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"
      }
    }

    Example2 This example shows you how to query bandwidth statistics of the 123.vod2.myqcloud.com and test.a.com domain names with 5-minute granularity between December 1, 2018 to December 7, 2018.

    This example shows you how to query the CDN traffic statistics between December 1, 2018 (inclusive) and December 3, 2018 (inclusive).

    Input Example

    https://vod.tencentcloudapi.com/?Action=DescribeCDNUsageData
    &DomainNames.0=123.vod2.myqcloud.com
    &DomainNames.1=test.a.com
    &StartTime=2018-12-01T00:00:00+08:00
    &EndTime=2018-12-03T00:00:00+08:00
    &DataType=Bandwidth
    &DataInterval=5
    &<Common request parameters>

    Output Example

    {
      "Response": {
        "DataInterval": 5,
        "Data": [
          {
            "Time": "2018-12-01T00:00:00+08:00",
            "Value": 100000
          },
          {
            "Time": "2018-12-01T05:00:00+08:00",
            "Value": 200000
          },
          {
            "Time": "2018-12-01T10:00:00+08:00",
            "Value": 350000
          }
        ],
        "RequestId": "requestId"
      }
    }

    Example3 Querying bandwidth statistics of all domain names between December 1, 2018 and December 7, 2018 by an admin

    Input Example

    https://vod.tencentcloudapi.com/?Action=DescribeCDNUsageData
    &StartTime=2018-12-01T00:00:00+08:00
    &EndTime=2018-12-03T00:00:00+08:00
    &DataType=Bandwidth
    &SubAppId=1
    &<Common request parameters>

    Output Example

    {
      "Response": {
        "DataInterval": 1440,
        "Data": [
          {
            "Time": "2018-12-01T00:00:00+08:00",
            "Value": 700000
          },
          {
            "Time": "2018-12-01T05:00:00+08:00",
            "Value": 800000
          },
          {
            "Time": "2018-12-01T10:00:00+08:00",
            "Value": 920000
          }
        ],
        "RequestId": "requestId"
      }
    }

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    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
    InternalError Internal error.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.DataInterval Incorrect parameter value: time granularity.
    InvalidParameterValue.DataType Incorrect parameter value: data type.
    InvalidParameterValue.DomainName Invalid parameter: the domain name does not exist.
    InvalidParameterValue.DomainNames Parameter value. The domain name list is too large.
    InvalidParameterValue.EndTime Incorrect parameter value: invalid EndTime.
    InvalidParameterValue.StartTime Incorrect parameter value: invalid StartTime.
    UnauthorizedOperation Unauthorized operation.