1. 接口描述
接口请求域名: ecdn.tencentcloudapi.com 。
本接口(DescribeEcdnDomainStatistics)用于查询指定时间段内的域名访问统计指标。
说明:若您的业务已迁移至 CDN 控制台,请参考 CDN 接口文档,使用 CDN 相关API 进行操作。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeEcdnDomainStatistics。 |
Version | 是 | String | 公共参数,本接口取值:2019-10-12。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
StartTime | 是 | Timestamp | 查询起始时间,如:2019-12-13 00:00:00。 起止时间不超过90天。 示例值:2018-09-04 00:00:00 |
EndTime | 是 | Timestamp | 查询结束时间,如:2019-12-13 23:59:59。 起止时间不超过90天。 示例值:2018-09-04 12:00:00 |
Metrics.N | 是 | Array of String | 统计指标名称: flux:流量,单位为 byte bandwidth:带宽,单位为 bps request:请求数,单位为 次 示例值:["flux\n","delay\n","request\n","bandwidth\n"] |
Domains.N | 否 | Array of String | 指定查询域名列表 示例值:["www.test.com\n"] |
Projects.N | 否 | Array of Integer | 指定要查询的项目 ID,前往查看项目 ID 未填充域名情况下,指定项目查询,若填充了具体域名信息,以域名为主 示例值:["0\n"] |
Offset | 否 | Integer | 列表分页起始地址,默认0。 示例值:0 |
Limit | 否 | Integer | 列表分页记录条数,默认1000,最大3000。 示例值:1000 |
Area | 否 | String | 统计区域: mainland: 境内 oversea: 境外 global: 全部 默认 global 示例值:global |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | Array of DomainData | 域名数据 |
TotalCount | Integer | 数量 示例值:20 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 域名统计指标查询
输入示例
https://ecdn.tencentcloudapi.com/?Action=DescribeEcdnDomainStatistics
&StartTime=2018-09-04 00:00:00
&EndTime=2018-09-04 12:00:00
&Metrics.0=flux
&Metrics.1=delay
&Metrics.2=request
&Metrics.3=bandwidth
&Domains.0=www.test.com
&Projects.0=0
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "13d41d37-546f-42ed-a3b9-ff82a51ecd0a",
"Data": [
{
"Resource": "www.test.com",
"DetailData": [
{
"Name": "request",
"Value": 5628872958
},
{
"Name": "flux",
"Value": 3535122082980
},
{
"Name": "delay",
"Value": 87
},
{
"Name": "bandwidth",
"Value": 825782981
}
]
}
],
"TotalCount": 20
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError.EcdnDbError | 内部数据错误,请联系腾讯云工程师进一步排查。 |
InternalError.EcdnSystemError | 系统错误,请联系腾讯云工程师进一步排查。 |
InvalidParameter.EcdnParamError | 参数错误,请参考文档中示例参数填充。 |
InvalidParameter.EcdnStatInvalidDate | 日期不合法,请参考文档中日期示例。 |
InvalidParameter.EcdnStatInvalidMetric | 统计类型不合法,请参考文档中统计分析示例。 |
InvalidParameter.ParamError | 参数错误。 |
LimitExceeded.EcdnDomainOpTooOften | 域名操作过于频繁。 |
ResourceNotFound.EcdnDomainNotExists | 账号下无此域名,请确认后重试。 |
ResourceNotFound.EcdnProjectNotExists | 项目不存在。 |
ResourceNotFound.EcdnUserNotExists | 未开通ECDN服务,请开通后使用此接口。 |
UnauthorizedOperation.CdnAccountUnauthorized | 子账号禁止查询整体数据。 |
UnauthorizedOperation.CdnCamUnauthorized | 子账号未配置cam策略。 |
UnauthorizedOperation.CdnDomainUnauthorized | ECDN子账号加速域名未授权。 |
UnauthorizedOperation.CdnHostUnauthorized | ECDN子账号加速域名未授权。 |
UnauthorizedOperation.CdnNoDomainUnauthorized | 子账号没有授权域名权限,请授权后重试。 |
UnauthorizedOperation.CdnProjectUnauthorized | 子账号项目未授权。 |
UnauthorizedOperation.DomainNoPermission | ECDN 子账号加速域名未授权。 |
UnauthorizedOperation.DomainsNoPermission | ECDN 子账号加速域名未授权。 |
UnauthorizedOperation.EcdnAccountUnauthorized | 子账号禁止查询整体数据。 |
UnauthorizedOperation.EcdnCamUnauthorized | 子账号未配置cam策略。 |
UnauthorizedOperation.EcdnDomainUnauthorized | ECDN子账号加速域名未授权。 |
UnauthorizedOperation.EcdnHostUnauthorized | ECDN子账号加速域名未授权。 |
UnauthorizedOperation.EcdnNoDomainUnauthorized | 子账号没有授权域名权限,请授权后重试。 |
UnauthorizedOperation.EcdnProjectUnauthorized | 子账号项目未授权。 |
UnauthorizedOperation.NoPermission | ECDN 子账号cam未授权。 |
UnauthorizedOperation.ProjectNoPermission | ECDN 子账号项目未授权。 |
UnauthorizedOperation.ProjectsNoPermission | ECDN 子账号项目未授权。 |