全部产品
Search
文档中心

边缘安全加速:DescribeDcdnReport - 查询已定制的报表数据

更新时间:Oct 17, 2024

调用DescribeDcdnReport查询已定制的报表数据。

接口说明

说明 单用户调用频率:3 次/秒。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
DomainNamestring

待查询的域名列表,多个域名用英文逗号(,)分隔。

www.example.com,www.example.org
ReportIdlong

待查询的报表 ID,每次调用仅支持传入单个报表 ID。您可以调用 DescribeDcdnSubList 接口查询报表 ID。

2
Areastring

地域英文名,您可以调用 DescribeDcdnRegionAndIsp 接口获取地域英文名。

  • 如果不传该参数,默认查询全部地域。
  • 如果传入指定地域,则按照指定的地域获取相应数据。支持传入多个地域,多个地域用英文逗号(,)分隔。
shanghai
IsOverseasstring

是否为中国内地以外的区域。取值:

  • 1:中国内地以外的区域。
  • 0:中国内地。
0
HttpCodestring

HTTP 状态码。取值:

  • 2xx:2xx 状态码。
  • 3xx:3xx 状态码。
  • 4xx:4xx 状态码。
  • 5xx:5xx 状态码。

如果不传该参数,默认查询以上全部 HTTP 状态码。

2xx
StartTimestring

查询开始时间。使用 UTC+0 时间表示,格式为 yyyy-MM-ddTHH:mm:ssZ。

2021-07-02T00:00:00Z
EndTimestring

查询结束时间。使用 UTC+0 时间表示,格式为 yyyy-MM-ddTHH:mm:ssZ。

2021-07-02T01:00:00Z

各报表必传的请求参数说明

报表名称必传参数说明
PV 和 UVAction、ReportId、DomainName、StartTime、EndTime。不支持其他参数。
Top 客户端 IP(按流量排序)Action、ReportId、DomainName、Area、StartTime、EndTime。不支持其他参数。
Top 客户端 IP(按请求数排序)Action、ReportId、DomainName、Area、StartTime、EndTime。不支持其他参数。
访问区域分布Action、ReportId、DomainName、IsOverseas、StartTime、EndTime。不支持其他参数。
运营商分布Action、ReportId、DomainName、IsOverseas、StartTime、EndTime。不支持其他参数。
热门 Referer(按流量排序)Action、ReportId、DomainName、StartTime、EndTime。不支持其他参数。
热门 Referer(按请求数排序)Action、ReportId、DomainName、StartTime、EndTime。不支持其他参数。
热门 URL(按流量排序)Action、ReportId、DomainName、HttpCode、StartTime、EndTime。不支持其他参数。
热门 URL(按请求数排序)Action、ReportId、DomainName、HttpCode、StartTime、EndTime。不支持其他参数。
回源热门 URL(按流量排序)Action、ReportId、DomainName、HttpCode、StartTime、EndTime。不支持其他参数。
回源热门 URL(按请求数排序)Action、ReportId、DomainName、HttpCode、StartTime、EndTime。不支持其他参数。
域名排行(按流量排序)Action、ReportId、StartTime、EndTime。不支持其他参数。

返回参数

名称类型描述示例值
object
Contentobject

查询到的报表数据。

"data":[{"deliver":{ "report":{"title":"TopUrlByAcc","format":"table","sape":"","header":["url","traf","traf_rate","acc","acc_rate"]}}, "data":[{"acc":440,"acc_rate":"0.200%","traf":22,"url":"http://example.com","traf_rate":"0.100%"},{"acc":440,"acc_rate":"0.200%","traf":22,"url":"http://example.org","traf_rate":"0.100%"}]}]
RequestIdstring

请求 ID。

04F0F334-1335-436C-A1D7-6C044FE73368

Content 数据说明

参数类型描述
deliverreport报表样式。
dataString[]报表中的数据,例如:[{"表头字段 1":"value1","表头字段 2":"value2"}, {"表头字段 1":"value3","表头字段 2":"value4"}]。

report 数据说明

参数类型描述
titleString报表标题。
formatString报表类型。取值如下:
chart:图表。
table:表格。
shapeString图表类型。当 format 为 table 时,请忽略此字段。取值如下:
line:曲线图。
pie:饼状图。
bar:柱状图。
headerString[]报表的表头字段。
legendString图形的图例字段。
xAxisString图形 x 轴,没有则为空。
yAxisString图形 y 轴,没有则为空。

示例

正常返回示例

JSON格式

{
  "Content": {
    "test": "test",
    "test2": 1
  },
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe specified parameter is invalid.参数错误
400TimeParseFailedFailed to parse the time parameter.解析时间参数失败
400SubscriptionAlreadyExistsThe subscription already exists.定制服务已开通
400SubscriptionNotFoundThe subscription is not found.未开通定制服务
400NameAlreadyExistsThe name already exists.名称已存在
400DeliverExceedLimitThe maximum number of subscribed tasks is exceeded.订阅任务个数已达上限

访问错误中心查看更多错误码。