阅读990 返回首页    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-阿里云