文档中心>API 中心>云点播>数据统计相关接口>查询点播域名的 CDN 统计数据

查询点播域名的 CDN 统计数据

最近更新时间:2024-03-12 02:01:12

我的收藏

1. 接口描述

接口请求域名: vod.tencentcloudapi.com 。

该接口用于查询点播域名的 CDN 带宽、流量等统计数据。

  • 查询的起始时间和结束时间跨度不超过90天。
  • 可以查询不同服务区域的数据。
  • 中国境内的数据支持查询指定地区、运营商的统计数据。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCDNStatDetails。
Version String 公共参数,本接口取值:2018-07-17。
Region String 公共参数,此参数为可选参数。
Metric String 查询指标,取值有:
  • Traffic:流量,单位为 Byte。
  • Bandwidth:带宽,单位为 Bps。
  • Requests:请求数。
  • QUICRequests:QUIC 请求数。
  • IpVisit:IP 访问数。

  • 示例值:Traffic
    StartTime String 起始时间,使用 ISO 日期格式
    示例值:2023-08-01T10:00:00Z
    EndTime String 结束时间,使用 ISO 日期格式
    示例值:2023-08-02T10:00:00Z
    SubAppId Integer 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
    示例值:1490012345
    DomainNames.N Array of String 域名列表。一次最多查询20个域名的数据。默认返回所有域名叠加的用量数据。
    示例值:["myexample.com","myexample2.com"]
    Area String 服务区域,取值有:
  • Chinese Mainland:中国大陆。
  • Asia Pacific Region 1:亚太一区,包括中国香港、中国澳门、新加坡、越南、泰国。
  • Asia Pacific Region 2:亚太二区,包括中国台湾、日本、马来西亚、印度尼西亚、韩国。
  • Asia Pacific Region 3:亚太三区,包括菲律宾、印度、澳大利亚和亚太其它国家和地区。
  • Middle East:中东。
  • Europe:欧洲。
  • North America:北美。
  • South America:南美。
  • Africa:非洲。

  • 默认为中国大陆。
    示例值:Chinese Mainland
    Districts.N Array of String 用户所在地区,Area 为 Chinese Mainland 时,取值为以下地区信息,当 Area 为其它值时, 忽略 Districts 参数。
  • 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:其他 。

  • 示例值:["Beijing", "Shanxi"]
    Isps.N Array of String 用户所属运营商信息,Area 为 Chinese Mainland 时,取值为以下运营商信息。当 Area 为其它值时忽略 Isps 参数。
  • China Telecom:中国电信。
  • China Unicom:中国联通。
  • CERNET:教育网。
  • Great Wall Broadband Network:长城宽带。
  • China Mobile:中国移动。
  • China Mobile Tietong:中国铁通。
  • ISPs outside Chinese Mainland:海外运营商。
  • Other ISPs:其他运营商。

  • 示例值:["Chinese Mainland"]
    DataInterval Integer 每条数据的时间粒度,单位:分钟,取值有:
  • 5:5 分钟粒度,返回指定查询时间内5分钟粒度的明细数据。
  • 1440:天粒度,返回指定查询时间内1天粒度的数据。起始时间和结束时间跨度大于24小时,只支持天粒度的数据。

  • 当 StartTime 和 EndTime 时间跨度大于24小时时,DataInterval 默认为 1440。
    示例值:5

    3. 输出参数

    参数名称 类型 描述
    DataInterval Integer 每条数据的时间粒度,单位:分钟。
    示例值:5
    Data Array of StatDataItem CDN 用量数据。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询域名123.vod2.com中国大陆的流量数据。

    查询域名123.vod2.com中国大陆的流量数据。

    输入示例

    https://vod.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
    &<公共请求参数>

    输出示例

    {
        "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. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    AuthFailure CAM签名/鉴权错误。
    FailedOperation 操作失败。
    FailedOperation.InvalidAccount 用户账户异常。
    FailedOperation.InvalidVodUser 没有开通点播业务。
    InternalError.DBError 内部错误,访问DB失败。
    InvalidParameterValue.Area Area 参数错误。
    InvalidParameterValue.Districts Districts 参数值错误。
    InvalidParameterValue.DomainNames 参数值,域名列表太大。
    InvalidParameterValue.EndTime 参数值错误:EndTime 无效。
    InvalidParameterValue.Isps Isps 参数错误。
    InvalidParameterValue.Metric 参数错误:Metric 无效。
    InvalidParameterValue.StartTime 参数值错误:StartTime 无效。