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

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeCdnReport

系统规定参数。取值:DescribeCdnReport

DomainName String www.example1.com,example2.com

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

ReportId Long 1

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

Area String shanghai

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

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

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

  • 1:中国内地以外的区域。
  • 0:中国内地。
HttpCode String 2xx

HTTP状态码。取值:

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

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

StartTime String 2020-09-17T00:00:00Z

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

EndTime String 2020-09-17T01:00:00Z

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

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

报表名称

必传参数

说明

PV和UV

Action、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。

不支持其他参数。

返回数据

名称 类型 示例值 描述
Content String "data":[{"deliver":{"report":{"title":"TopUrlByAcc","format":"table","shape":"","header":["url","traf","traf_rate","acc","acc_rate"]}},"data":[{"acc":440,"acc_rate":"0.200%","traf":22,"url":"http://demo.com","traf_rate":"0.100%"},{"acc":440,"acc_rate":"0.200%","traf":22,"url":"http://demo.com","traf_rate":"0.100%"}]}]}}

查询到的报表数据。

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

请求ID。

data数据说明

参数

类型

描述

deliver

report

报表样式。

data

String[]

报表中的数据,例如:[{"表头字段1":"value1","表头字段2":"value2"}, {"表头字段1":"value3","表头字段2":"value4"}]。

report数据说明

参数

类型

描述

title

String

报表标题。

format

String

报表类型。取值如下:

chart:图表。

table:表格。

shape

String

图表类型。当format为table时,请忽略此字段。取值如下:

line:曲线图。

pie:饼状图。

bar:柱状图。

header

String[]

报表的表头字段。

legend

String

图形的图例字段。

xAxis

String

图形x轴,没有则为空。

yAxis

String

图形y轴,没有则为空。

示例

请求示例

http://cdn.aliyuncs.com?Action=DescribeCdnReport
&ReportId=1
&DomainName=www.example1.com,www.example2.com
&StartTime=2020-09-17T00:00:00Z
&EndTime=2020-09-17T01:00:00Z
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeCdnReportResponse>
    <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
    <Description>成功</Description>
    <Content>
        <data>
            <deliver>
                <report>
                    <title>TopUrlByAcc</title>
                    <format>table</format>
                    <shape/>
                    <header>url</header>
                    <header>traf</header>
                    <header>traf_rate</header>
                    <header>acc</header>
                    <header>acc_rate</header>
                </report>
            </deliver>
            <data>
                <acc>440</acc>
                <acc_rate>0.200%</acc_rate>
                <traf>22</traf>
                <url>http://demo.com</url>
                <traf_rate>0.100%</traf_rate>
            </data>
            <data>
                <acc>440</acc>
                <acc_rate>0.200%</acc_rate>
                <traf>22</traf>
                <url>http://demo.com</url>
                <traf_rate>0.100%</traf_rate>
            </data>
        </data>
    </Content>
</DescribeCdnReportResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "04F0F334-1335-436C-A1D7-6C044FE73368",
  "Description" : "成功",
  "Content" : {
    "data" : [ {
      "deliver" : {
        "report" : {
          "title" : "TopUrlByAcc",
          "format" : "table",
          "shape" : "",
          "header" : [ "url", "traf", "traf_rate", "acc", "acc_rate" ]
        }
      },
      "data" : [ {
        "acc" : 440,
        "acc_rate" : "0.200%",
        "traf" : 22,
        "url" : "http://demo.com",
        "traf_rate" : "0.100%"
      }, {
        "acc" : 440,
        "acc_rate" : "0.200%",
        "traf" : 22,
        "url" : "http://demo.com",
        "traf_rate" : "0.100%"
      } ]
    } ]
  }
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidParameter The specified parameter is invalid. 参数错误
400 TimeParseFailed Failed to parse the time parameter. 解析时间参数失败
400 SubscriptionAlreadyExists The subscription already exists. 定制服务已开通
400 SubscriptionNotFound The subscription is not found. 未开通定制服务
400 NameAlreadyExists The name already exists. 名称已存在
400 DeliverExceedLimit The maximum number of subscribed tasks is exceeded. 订阅任务个数已达上限

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