調用DescribeCdnReport查詢已定制的報表數據。
接口說明
說明
單用戶調用頻率:3 次/秒。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
cdn:DescribeCdnReport | get | *Domain acs:cdn:*:{#accountId}:domain/{#DomainName} |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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. | 訂閱任務個數已達上限 |
訪問錯誤中心查看更多錯誤碼。