閱讀990 返回首頁    go 阿裏雲 go 技術社區[雲棲]

查詢網絡帶寬__資源監控接口_API 手冊_CDN-阿裏雲

DescribeDomainBpsData

描述

獲取加速域名的網絡帶寬監控數據，單位bit/second

不指定StartTime和EndTime時，默認讀取過去24小時的數據，同時支持按指定的起止時間查詢，兩者需要同時指定。

  • 支持批量域名查詢，多個域名用逗號（半角）分隔
  • 最多可獲取最近90天的數據

請求參數

參數 類型 必要 描述
Action String 是 操作接口名，係統規定參數
取值：DescribeDomainBpsData
DomainName String 否 若參數為空，默認返回所有加速域名合並後數據
可輸入需要查詢的加速域名
支持批量域名查詢，多個域名用逗號（半角）分隔，若需要查詢全部域名數據
StartTime String 否 獲取數據起始時間點，日期格式按照ISO8601表示法，並使用UTC時間。
格式為：YYYY-MM-DDThh:mmZ
最小數據粒度為5分鍾
不寫默認讀取過去24小時數據
EndTime String 否 結束時間需大於起始時間；獲日期格式按照ISO8601表示法，並使用UTC時間。
格式為：YYYY-MM-DDThh:mmZ
TimeMerge String 否 取值範圍 on：默認值，每條記錄的時間間隔會根據時間跨度做合並；off：返回5分鍾粒度數據，單最大時間跨度為31天
LocationNameEn String 否 區域英文名，通過DescribeCdnRegionAndIsp接口獲得，不傳為所有區域
IspNameEn String 否 運營商英文名，通過DescribeCdnRegionAndIsp接口獲得，不傳為所有運營商

返回參數

名稱 類型 描述
DomainName String 加速域名信息
DataInterval String [需要補充時間間隔規則]每條記錄的時間間隔，以秒為單位
StartTime DateTime 開始時間
EndTime DateTime 結束時間
BpsDataPerInterval UsageData[] 每個時間間隔的網絡帶寬數據
SupplyBpsDatas UsageData[] 補充最近30分鍾內參考實時帶寬數據，可能不存在

UsageData

名稱 類型 描述
TimeStamp String 時間片起始時刻
Vaule String bps數據值，單位：bit/second
DomesticVaule String 國內帶寬bps，當按區域運營商查詢時，此值為空
OverseasVaule String 海外帶寬bps，當按區域運營商查詢時，此值為空

特殊錯誤碼

錯誤代碼 描述 Http 狀態碼 語義
Throttling Request was denied due to request throttling. 503 請求被流量控製限製
IllegalOperation Illegal domain, operation is not permitted. 403 非法域名, 無法操作
OperationDenied Your account does not open CDN service yet. 403 未開通CDN服務
OperationDenied Your CDN service is suspended. 403 CDN服務已被停止
InvalidDomain.NotFound The domain provided does not belong to you. 404 域名不存在或不屬於當前用戶
InvalidDomain.Offline The domain provided is offline. 404 域名已下線
ServiceBusy The specified Domain is configuring, please retry later. 403 域名正在配置中, 請稍後再試
InvalidDomain.Configure_failed Failed to configure the provided domain. 500 域名配置失敗
MissingParameter StartTime and EndTime can not be single. 400 StartTime和EndTime不能單獨設置
InvalidStartTime.Malformed Specified start time is malformed. 400 StartTime格式錯誤
InvalidEndTime.Malformed Specified end time is malformed. 400 EndTime格式錯誤
InvalidEndTime.Mismatch Specified end time does not math the specified start time. 400 EndTime小於StartTime
InvalidStartTime.ValueNotSupported Specified end time does not math the specified start time. 400 EndTime和StartTime差值超過90天
InvalidTimeMerge.ValueNotSupported When value of parameter TimeMerge is off, maximum time interval is 31 days. 400 當TimeMerge為off時，最大時間跨度為31天

示例

請求示例：

  1. https://cdn.aliyuncs.com?Action=DescribeDomainBpsData&DomainName=test.com
  2. &StartTime=2015-12-10T20:00Z
  3. &EndTime=2015-12-10T21:00Z
  4. &<公共請求參數>

返回示例：

JSON格式

  1. {
  2.     "BpsDataPerInterval": {
  3.         "DataModule": [
  4.             {
  5.                 "TimeStamp": "2015-12-10T20:00:00Z",
  6.                 "Value": "11288111",
  7.                 "DomesticVaule": "11286111",
  8.                 "OverseasVaule": "2000"
  9.             },
  10.             {
  11.                 "TimeStamp": "2015-12-10T20:05:00Z",
  12.                 "Value": "12124821"
  13.                 "DomesticVaule": "12112821",
  14.                 "OverseasVaule": "12000"
  15.             }
  16.         ]
  17.     },
  18.     "SupplyBpsDatas": {
  19.       "DataModule": [
  20.         {
  21.           "TimeStamp": "2015-12-10T20:05:00Z",
  22.           "Value": "12124821"
  23.         },
  24.         {
  25.           "TimeStamp": "2015-12-10T20:06:00Z",
  26.           "Value": "12144838"
  27.         }
  28.       ]
  29.     }
  30.     "DomainName": "test.com",
  31.     "DataInterval": "300",
  32.     "RequestId": "3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F",
  33.     "StartTime": "2015-12-10T20:00Z",
  34.     "EndTime": "2015-12-10T21:00Z"
  35. }

XML格式：

  1. <?xml version="1.0" ?>
  2. <DescribeDomainBpsDataResponse>
  3.         <DataInterval>300</DataInterval>
  4.         <BpsDataPerInterval>
  5.                 <DataModule>
  6.                         <TimeStamp>2015-12-10T21:00:00Z</TimeStamp>
  7.                         <Value>11431540</Value>
  8.                         <DomesticVaule>11131540</DomesticVaule>
  9.                         <OverseasVaule>300000</OverseasVaule>
  10.                 </DataModule>
  11.                 <DataModule>
  12.                         <TimeStamp>2015-12-10T20:35:00Z</TimeStamp>
  13.                         <Value>12793665</Value>
  14.                         <DomesticVaule>12791665</DomesticVaule>
  15.                         <OverseasVaule>2000</OverseasVaule>
  16.                 </DataModule>
  17.         </BpsDataPerInterval>
  18.         <SupplyBpsDatas>
  19.               <DataModule>
  20.                   <TimeStamp>2015-12-10T20:35:00Z</TimeStamp>
  21.                   <Value>12793665</Value>
  22.               </DataModule>
  23.               <DataModule>
  24.                   <TimeStamp>2015-12-10T20:36:00Z</TimeStamp>
  25.                   <Value>19011526</Value>
  26.               </DataModule>
  27.         </SupplyBpsDatas>
  28.         <RequestId>AA2981FF-1A30-4590-B929-88FC85E12A8B</RequestId>
  29.         <DomainName>test.com</DomainName>
  30.         <EndTime>2015-12-10T21:00Z</EndTime>
  31.         <StartTime>2015-12-10T20:00Z</StartTime>
  32. </DescribeDomainBpsDataResponse>

最後更新：2016-11-24 17:17:09

  上一篇：go 設置證書__配置操作接口_API 手冊_CDN-阿裏雲
  下一篇：go 查詢流量數據__資源監控接口_API 手冊_CDN-阿裏雲