调用DescribeCdnReport查询已定制的报表数据。
接口说明
说明
单用户调用频率：3 次/秒。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| cdn:DescribeCdnReport | Read |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DomainName | string | 否 | 待查询的域名列表，多个域名用英文逗号（,）分隔。 | www.example1.com,example2.com |
| ReportId | long | 是 | 待查询的报表 ID，每次调用仅支持传入单个报表 ID。您可以调用 DescribeCdnSubList 接口查询报表 ID。 | 1 |
| Area | string | 否 | 地域英文名，您可以调用 DescribeCdnRegionAndIsp 接口获取地域英文名。
| shanghai |
| IsOverseas | string | 否 | 是否为中国内地以外的区域。取值：
| 0 |
| HttpCode | string | 否 | HTTP 状态码。取值：
如果不传该参数，默认查询以上全部 HTTP 状态码。 | 2xx |
| StartTime | string | 是 | 查询开始时间。使用 UTC+0 时间表示，格式为 yyyy-MM-ddTHH:mm:ssZ。 | 2020-09-17T00:00:00Z |
| EndTime | string | 是 | 查询结束时间。使用 UTC+0 时间表示，格式为 yyyy-MM-ddTHH:mm:ssZ。 | 2020-09-17T01:00:00Z |
各报表必传的请求参数说明
| 报表名称 | 必传参数 | 说明 |
|---|---|---|
| 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。 | 不支持其他参数。 |
返回参数
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 轴，没有则为空。 |
示例
正常返回示例
JSON格式
{
"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%"
}
]
}
]
},
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 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. | 订阅任务个数已达上限 |
访问错误中心查看更多错误码。