调用DescribeCdnReportList接口查询所有的定制报表列表。
接口说明
该接口将返回所有定制报表的元数据,不包含具体报表的统计数据。
单用户调用频率:3 次/秒。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
cdn:DescribeCdnReportList |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ReportId |
integer |
否 |
待查询的报表 ID。如果不传该参数,默认查询所有报表。 |
1 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回主体 |
||
| RequestId |
string |
请求 ID。 |
04F0F334-1335-436C-A1D7-6C044FE73368 |
| Content |
object |
报表列表。 |
"data":[{"reportId":1,"deliver":{"report":{"title":"DomainPvUv","format":"chart","shape":"line","xAxis":"ds","yAxis":"cnt","legend":"cnt_type","header":["ds","cnt_type","cnt"]}}} |
| data |
array<object> |
||
|
array<object> |
返回报表主体 |
||
| deliver |
object |
报表展示形式 |
|
| report |
object |
报表信息 |
|
| format |
string |
展示形式 |
table |
| header |
array |
表格表头列表 |
|
|
string |
表头 |
url |
|
| outLine |
integer |
输出行数 |
0 |
| outSize |
integer |
输出大小 |
0 |
| shape |
string |
报表展示图形 |
line |
| title |
string |
报表标题 |
TopUrlByAcc |
| reportId |
integer |
报表 ID |
1 |
data 数据说明
| 参数 | 类型 | 描述 |
| reportId | Long | 任务的请求 ID。 |
| deliver | report | 报表样式。 |
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格式
{
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
"Content": {
"data": [
{
"deliver": {
"report": {
"format": "table",
"header": [
"url"
],
"outLine": 0,
"outSize": 0,
"shape": "line",
"title": "TopUrlByAcc"
}
},
"reportId": 1
}
]
}
}
错误码
|
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. | 订阅任务个数已达上限 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。