BandwidthPeakRanking
Rank the channel in the order of bandwidth's peak value.
- リミットの詳細: 2000 channels at most in one query
- 単一ユーザーの使用頻度: 100/5min
- 使用できるプロダクト: APM,Dynamic Web Acceleration,Web Application Firewall,API Shield,Edge Application,Edge Computing Hosting,Object Storage,Content Acceleration,Media Acceleration Live Broadcast,Bot Shield,Flood Shield,Application Shield,CDN Pro,Flood Shield 2.0
リクエストパラメータ
Body パラメータ
| パラメータ名 | 説明 |
|---|---|
dateString | Specifies the query date: 1.With format yyyy-mm-dd. 2.If not specified,it means today as default. |
startdateString | 1.Must work with 'enddate' and they specify the query date scope. 2.With format yyyy-mm-dd. 3.If there is a 'date' parameter,this parameter will be omitted. |
enddateString | 1.Must work with 'startdate' and they specify the query date scope. 2.With format yyyy-mm-dd. 3.If there is a 'date' parameter,this parameter will be omitted. |
channelString | domains that been queried: 1.If there are multiple inputs,use ';' as separator. 2.If not specified, it means all the domains of the account . |
regionString | 選択可能な値：パラメータ値を表示する 1.If there are multiple inputs,use ';' as separator.For example,u can use 'region=cn;apac' to query data of cn and apac region. 2.If not specified, it means all the regions. |
ispString | 選択可能な値：パラメータ値を表示する The abbreviations of the ISPs to be queried. For multiple ISPs, please separate them with a semicolon ';'. Note: Only when the region is specified as 'cn' does the ISP information take effect. If not selected or left blank, all ISPs will be included by default. |
accetypeString | acceleration type. 1.If there are multiple inputs,use ';' as separator. 2.If not specified or specified as 'all', it means all the accetypes. |
dataformatString | The response format: 1.optional values:xml, json. 2.'xml' as default. |
isExactMatchString | Specifies if the 'channel' parameter should be exactly matched: 1.'true' as default. 2. If not 'true',it will query data of channels that ends with any item of input 'channel's. |
datatypeString | Different data types. 1.optional values:1,2,3. 2.'2' means bandwidth of http.'3' means bandwidth of https.'1' mean the total bandwidth. 3.If specified 2 or 3, ISP parameter is not supported. |
timezoneString | Greenwich Mean Time, parameter format GMT%2b09:00 represents Eastern 9th Zone, GMT-09:00 represents Western 9th Zone, if not specified, it defaults to local time zone (Eastern 8th Zone). |
レスポンスパラメータ
Body パラメータ
| パラメータ名 | 説明 |
|---|---|
providerObject | provider |
nameString | tenant |
typeString | type |
dateObject | data |
startdateString | startdate |
enddateString | enddate |
channelPeakObject | channelPeak |
channelString | channel |
peakTimeString | peakTime |
peakValueString | peakvalue(Mbps) |
totalFlowString | total traffic,unit GB |
エラーコード
| エラーコード(code) | 説明(message) | HTTPステータスコード | 意味 |
|---|---|---|---|
| 403 | invalid region/invalid channel/no channel/date range exceed limit | 403 | invalid region/invalid channel/no channel/date range exceed limit |
| 500 | internal error | 500 | internal error |
入力例
- リクエスト例 コピー完了
#!/bin/bash username="example_username" apiKey="example_apikey" date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"` password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64` curl -i --url "https://api.cdnetworks.com/myview/bandwidth-peak-ranking" \ -X "POST" \ -u "$username:$password" \ -H "Date: $date" \ -H "Accept: application/xml" \ -d "channel=test.com&startdate=2018-02-02&enddate=2018-02-03&dataformat=json"
- レスポンス例 コピー完了
{ "provider":{ "name":"${ProviderName}", "type":"bandwidth-peak-ranking", "date":{ "startdate":"2017-07-16", "enddate":"2017-07-17", "channelPeak":[ { "channel":"a1.tv", "peakTime":"2017-07-16 21:10:00", "peakValue":"27573.23", "totalFlow":"315149.94" }, { "channel":"a2.tv", "peakTime":"2017-07-17 21:00:00", "peakValue":"9588.45", "totalFlow":"102876.86" } ] } } }