回源数据查询

最近更新时间:2019-07-24 15:13:22

1. 接口描述

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

DescribeOriginData 用于查询 CDN 实时回源监控数据,支持以下指标查询:

  • 回源流量(单位为 byte)
  • 回源带宽(单位为 bps)
  • 回源请求数(单位为 次)
  • 回源失败请求数(单位为 次)
  • 回源失败率(单位为 %,小数点后保留两位)
  • 回源状态码 2xx 汇总及各 2 开头回源状态码明细(单位为 个)
  • 回源状态码 3xx 汇总及各 3 开头回源状态码明细(单位为 个)
  • 回源状态码 4xx 汇总及各 4 开头回源状态码明细(单位为 个)
  • 回源状态码 5xx 汇总及各 5 开头回源状态码明细(单位为 个)

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeOriginData
Version String 公共参数,本接口取值:2018-06-06
Region String 公共参数,本接口不需要传递此参数。
StartTime Timestamp 查询起始时间,如:2018-09-04 10:40:00,返回结果大于等于指定时间
根据指定时间粒度不同,会进行向前归整,如 2018-09-04 10:40:00 在按 1 小时的时间粒度查询时,返回的第一个数据对应时间点为 2018-09-04 10:00:00
起始时间与结束时间间隔小于等于 90 天
EndTime Timestamp 查询结束时间,如:2018-09-04 10:40:00,返回结果小于等于指定时间
根据指定时间粒度不同,会进行向前归整,如 2018-09-04 10:40:00 在按 1 小时的时间粒度查询时,返回的最后一个数据对应时间点为 2018-09-04 10:00:00
起始时间与结束时间间隔小于等于 90 天
Metric String 指定查询指标,支持的类型有:
flux:回源流量,单位为 byte
bandwidth:回源带宽,单位为 bps
request:回源请求数,单位为 次
failRequest:回源失败请求数,单位为 次
failRate:回源失败率,单位为 %
statusCode:回源状态码,返回 2xx、3xx、4xx、5xx 汇总数据,单位为 个
2xx:返回 2xx 回源状态码汇总及各 2 开头回源状态码数据,单位为 个
3xx:返回 3xx 回源状态码汇总及各 3 开头回源状态码数据,单位为 个
4xx:返回 4xx 回源状态码汇总及各 4 开头回源状态码数据,单位为 个
5xx:返回 5xx 回源状态码汇总及各 5 开头回源状态码数据,单位为 个
支持指定具体状态码查询,若未产生过,则返回为空
Domains.N Array of String 指定查询域名列表,最多可一次性查询 30 个加速域名明细
Project Integer 指定要查询的项目 ID,前往查看项目 ID
未填充域名情况下,指定项目查询,若填充了具体域名信息,以域名为主
Interval String 时间粒度,支持以下几种模式:
min:1 分钟粒度,指定查询区间 24 小时内(含 24 小时),可返回 1 分钟粒度明细数据
5min:5 分钟粒度,指定查询区间 31 天内(含 31 天),可返回 5 分钟粒度明细数据
hour:1 小时粒度,指定查询区间 31 天内(含 31 天),可返回 1 小时粒度明细数据
day:天粒度,指定查询区间大于 31 天,可返回天粒度明细数据
Detail Boolean Domains 传入多个时,默认(false)返回多个域名的汇总数据
可按需指定为 true,返回每一个 Domain 的明细数据(statusCode 指标暂不支持)

3. 输出参数

参数名称 类型 描述
Interval String 数据统计的时间粒度,支持min, 5min, hour, day,分别表示1分钟,5分钟,1小时和1天的时间粒度。
Data Array of ResourceOriginData 各个资源的回源数据详情。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询Cdn回源数据

输入示例

https://cdn.tencentcloudapi.com/?Action=DescribeOriginData
&StartTime=2018-09-04 00:00:00
&EndTime=2018-09-04 12:00:00
&Metric=flux
&Domains.0=www.test.com
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "123",
    "Data": [
      {
        "Resource": "www.test.com",
        "OriginData": [
          {
            "Metric": "flux",
            "DetailData": [
              {
                "Time": "2018-09-03 00:00:00",
                "Value": 10
              },
              {
                "Time": "2018-09-03 00:05:00",
                "Value": 20
              }
            ],
            "SummarizedData": {
              "Name": "sum",
              "Value": 30
            }
          }
        ]
      }
    ],
    "Interval": 5
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.CdnDbError 内部数据错误,请联系腾讯云工程师进一步排查
InternalError.CdnSystemError 系统错误,请联系腾讯云工程师进一步排查
InvalidParameter.CdnHostInvalidMiddleConfig 错误的中间源配置。
InvalidParameter.CdnHostInvalidParam 域名格式不合法,请确认后重试
InvalidParameter.CdnInterfaceError 内部接口错误,请联系腾讯云工程师进一步排查
InvalidParameter.CdnParamError 参数错误,请参考文档中示例参数填充
InvalidParameter.CdnStatInvalidDate 日期不合法,请参考文档中日期示例
InvalidParameter.CdnStatInvalidMetric 统计类型不合法,请参考文档中统计分析示例
InvalidParameter.CdnStatInvalidProjectId 项目ID错误,请确认后重试
LimitExceeded.CdnHostOpTooOften 域名操作过于频繁。
ResourceNotFound.CdnHostNotExists 账号下无此域名,请确认后重试
ResourceNotFound.CdnUserNotExists 未开通CDN服务,请开通后使用此接口
ResourceNotFound.CdnUserTooManyHosts 接入域名数超出限制。
UnauthorizedOperation.CdnAccountUnauthorized 子账号禁止查询整体数据。
UnauthorizedOperation.CdnUserIsSuspended 加速服务已停服,请重启加速服务后重试
UnauthorizedOperation.CdnUserNoWhitelist 非内测白名单用户,无该功能使用权限