1. 接口描述
接口请求域名: cdn.tencentcloudapi.com 。
DescribeCdnData 用于查询 CDN 实时访问监控数据,支持以下指标查询:
- 流量(单位为 byte)
- 带宽(单位为 bps)
- 请求数(单位为 次)
- 命中请求数(单位为 次)
- 请求命中率(单位为 %)
- 命中流量(单位为 byte)
- 流量命中率(单位为 %)
- 状态码 2xx 汇总及各 2 开头状态码明细(单位为 个)
- 状态码 3xx 汇总及各 3 开头状态码明细(单位为 个)
- 状态码 4xx 汇总及各 4 开头状态码明细(单位为 个)
- 状态码 5xx 汇总及各 5 开头状态码明细(单位为 个)
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeCdnData。 |
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 天 示例值:2021-02-01 00:00:00 |
EndTime | 是 | Timestamp | 查询结束时间,如:2018-09-04 10:40:00,返回结果小于等于指定时间 根据指定时间粒度不同,会进行向前归整,如 2018-09-04 10:40:00 在按 1 小时的时间粒度查询时,返回的最后一个数据对应时间点为 2018-09-04 10:00:00 起始时间与结束时间间隔小于等于 90 天 示例值:2021-02-01 00:00:00 |
Metric | 是 | String | 指定查询指标,支持的类型有: flux:流量,单位为 byte fluxIn:上行流量,单位为 byte,该指标仅ecdn支持查询 fluxOut:下行流量,单位为 byte,该指标仅ecdn支持查询 bandwidth:带宽,单位为 bps bandwidthIn:上行带宽,单位为 bps,该指标仅ecdn支持查询 bandwidthOut:下行带宽,单位为 bps,该指标仅ecdn支持查询 request:请求数,单位为 次 hitRequest:命中请求数,单位为 次 requestHitRate:请求命中率,单位为 %,保留小数点后两位 hitFlux:命中流量,单位为byte fluxHitRate:流量命中率,单位为 %,保留小数点后两位 statusCode:状态码,返回 2xx、3xx、4xx、5xx 汇总数据,单位为 个 2xx:返回 2xx 状态码汇总及各 2 开头状态码数据,单位为 个 3xx:返回 3xx 状态码汇总及各 3 开头状态码数据,单位为 个 4xx:返回 4xx 状态码汇总及各 4 开头状态码数据,单位为 个 5xx:返回 5xx 状态码汇总及各 5 开头状态码数据,单位为 个 支持指定具体状态码查询,若未产生过,则返回为空 示例值:flux |
Domains.N | 否 | Array of String | 指定查询域名列表 查询单域名:指定单个域名 查询多个域名:指定多个域名,最多可一次性查询 30 个 查询账号下所有域名:不传参,默认查询账号维度 |
Project | 否 | Integer | 指定要查询的项目 ID,前往查看项目 ID 未填充域名情况下,指定项目查询,若填充了具体域名信息,以域名为主 示例值:0 |
Interval | 否 | String | 时间粒度,支持以下几种模式: min:1 分钟粒度,指定查询区间 24 小时内(含 24 小时),可返回 1 分钟粒度明细数据(指定查询服务地域为中国境外时不支持 1 分钟粒度) 5min:5 分钟粒度,指定查询区间 31 天内(含 31 天),可返回 5 分钟粒度明细数据 hour:1 小时粒度,指定查询区间 31 天内(含 31 天),可返回 1 小时粒度明细数据 day:天粒度,指定查询区间大于 31 天,可返回天粒度明细数据 示例值:day |
Detail | 否 | Boolean | 多域名查询时,默认(false)返回多个域名的汇总数据 可按需指定为 true,返回每一个 Domain 的明细数据(statusCode、2xx、3xx、4xx、5xx 指标暂不支持) 示例值:false |
Isp | 否 | Integer | 查询中国境内CDN数据时,指定运营商查询,不填充表示查询所有运营商 运营商编码可以查看 运营商编码映射 指定运营商查询时,不可同时指定省份、IP协议查询 |
District | 否 | Integer | 查询中国境内CDN数据时,指定省份查询,不填充表示查询所有省份 查询中国境外CDN数据时,指定国家/地区查询,不填充表示查询所有国家/地区 省份、国家/地区编码可以查看 省份编码映射 指定(中国境内)省份查询时,不可同时指定运营商、IP协议查询 |
Protocol | 否 | String | 指定协议查询,不填充表示查询所有协议 all:所有协议 http:指定查询 HTTP 对应指标 https:指定查询 HTTPS 对应指标 |
DataSource | 否 | String | 指定数据源查询,白名单功能 |
IpProtocol | 否 | String | 指定IP协议查询,不填充表示查询所有协议 all:所有协议 ipv4:指定查询 ipv4 对应指标 ipv6:指定查询 ipv6 对应指标 指定IP协议查询时,不可同时指定省份、运营商查询 注意:非IPv6白名单用户不可指定ipv4、ipv6进行查询 |
Area | 否 | String | 指定服务地域查询,不填充表示查询中国境内CDN数据 mainland:指定查询中国境内 CDN 数据 overseas:指定查询中国境外 CDN 数据 示例值:mainland |
AreaType | 否 | String | 查询中国境外CDN数据时,可指定地区类型查询,不填充表示查询服务地区数据(仅在 Area 为 overseas 时可用) server:指定查询服务地区(腾讯云 CDN 节点服务器所在地区)数据 client:指定查询客户端地区(用户请求终端所在地区)数据 |
Product | 否 | String | 指定查询的产品数据,可选为cdn或者ecdn,默认为cdn 示例值:cdn |
TimeZone | 否 | String | 指定查询时间的时区,默认UTC+08:00 示例值:UTC+08:00 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Interval | String | 返回数据的时间粒度,查询时指定: min:1 分钟粒度 5min:5 分钟粒度 hour:1 小时粒度 day:天粒度 示例值:day |
Data | Array of ResourceData | 指定条件查询得到的数据明细 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询Cdn访问数据
输入示例
https://cdn.tencentcloudapi.com/?Action=DescribeCdnData
&StartTime=2018-09-04 00:00:00
&EndTime=2018-09-04 12:00:00
&Metric=flux
&Domains.0=www.test.com
&Project=0
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "123",
"Data": [
{
"Resource": "www.test.com",
"CdnData": [
{
"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": "5min"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure.InvalidAuthorization | 鉴权错误,请确认后重试。 |
FailedOperation.CdnConfigError | 域名配置更新操作失败,请重试或联系客服人员解决。 |
InternalError.CamSystemError | 内部鉴权系统错误。 |
InternalError.CdnConfigError | 域名配置更新失败。 |
InternalError.CdnDbError | 内部数据错误,请联系腾讯云工程师进一步排查。 |
InternalError.CdnQuerySystemError | 内部查询错误,请重试或联系客服人员解决。 |
InternalError.CdnSystemError | 系统错误,请联系腾讯云工程师进一步排查。 |
InternalError.CostDataSystemError | 计费数据内部查询错误,请重试或联系客服人员解决。 |
InternalError.DataSystemError | 数据查询错误,请联系腾讯云工程师进一步排查。 |
InternalError.Error | 内部服务错误,请联系腾讯云工程师进一步排查。 |
InternalError.InvalidErrorCode | 内部服务错误,请联系腾讯云工程师进一步排查。 |
InternalError.ProxyServer | 内部服务错误,请联系腾讯云工程师进一步排查。 |
InternalError.RouteError | 内部服务错误,请联系腾讯云工程师进一步排查。 |
InternalError.TagSystemError | 标签内部错误,请重试或联系客服人员解决。 |
InvalidParameter.CdnHostInvalidParam | 域名格式不合法,请确认后重试。 |
InvalidParameter.CdnInterfaceError | 内部接口错误,请联系腾讯云工程师进一步排查。 |
InvalidParameter.CdnInvalidParamMetric | 参数Metric错误,请检查后重试。 |
InvalidParameter.CdnParamError | 参数错误,请参考文档中示例参数填充。 |
InvalidParameter.CdnStatInvalidDate | 日期不合法,请参考文档中日期示例。 |
InvalidParameter.CdnStatInvalidMetric | 统计类型不合法,请参考文档中统计分析示例。 |
InvalidParameter.CdnStatInvalidProjectId | 项目ID错误,请确认后重试。 |
InvalidParameter.CdnStatTooManyDomains | 查询的域名数量超过限制。 |
LimitExceeded.CdnHostOpTooOften | 域名操作过于频繁。 |
ResourceNotFound.CdnHostNotExists | 未查询到该域名,请确认域名是否正确。 |
ResourceNotFound.CdnProjectNotExists | 项目不存在,请确认后重试。 |
ResourceNotFound.CdnUserNotExists | 未开通CDN服务,请开通后使用此接口。 |
UnauthorizedOperation.CdnAccountUnauthorized | 子账号禁止查询整体数据。 |
UnauthorizedOperation.CdnCamUnauthorized | 子账号未配置cam策略。 |
UnauthorizedOperation.CdnHostUnauthorized | CDN子账号加速域名未授权。 |
UnauthorizedOperation.CdnProjectUnauthorized | 子账号项目未授权。 |
UnauthorizedOperation.CdnTagUnauthorized | 子账号标签未授权。 |
UnauthorizedOperation.CdnUserIsSuspended | 加速服务已停服,请重启加速服务后重试。 |
UnauthorizedOperation.CdnUserNoWhitelist | 非内测白名单用户,无该功能使用权限。 |
UnauthorizedOperation.CsrfError | 内部服务错误,请联系腾讯云工程师进一步排查。 |
UnauthorizedOperation.OpNoAuth | 暂不支持此操作,请联系腾讯云工程师处理。 |
UnauthorizedOperation.OperationTooOften | 操作超出调用频次限制。 |