获取网络带宽监控数据_数据监控类接口_新版API参考_CDN

说明

您查询的网络带宽监控数据单位：bit/s。
如果您不指定StartTime和EndTime，该接口返回过去24小时的数据；指定StartTime和EndTime，返回起止时间的数据。
支持获取最近90天的数据。
单用户调用频率：150次/秒。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeDomainBpsData	操作接口名，系统规定参数。取值：DescribeDomainBpsData。
DomainName	String	否	example.com	加速域名，多个域名使用英文逗号（,）分隔。默认查询所有加速域名。
StartTime	String	否	2020-05-14T09:50:00Z	获取数据起始时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。
EndTime	String	否	2020-05-14T10:00:00Z	获取数据结束时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。结束时间需大于起始时间。
Interval	String	否	300	查询数据的时间粒度，单位：秒。根据您指定StartTime和EndTime两者的时间跨度，取值如下： 3天以内（不包含3天整）支持300、3600、 86400，如果不传该参数，默认值为300。 3-31天（不包含31天整）支持3600和86400，如果不传该参数，默认值为3600。 31天及以上支持86400，如果不传该参数，默认值为86400。
IspNameEn	String	否	telecom	运营商英文名，通过DescribeCdnRegionAndIsp接口获得。默认查询所有运营商。
LocationNameEn	String	否	beijing	地域英文名，通过DescribeCdnRegionAndIsp接口获得。默认查询所有地域。

返回数据


名称	类型	示例值	描述
BpsDataPerInterval	Array of DataModule		每个时间间隔的网络带宽数据。
DataModule
DomesticValue	String	11286111	中国内地带宽。当按区域运营商查询时，此值为空。
HttpsDomesticValue	String	11286111	边缘节点HTTPS中国内地带宽。当按区域运营商查询时，此值为空。
HttpsOverseasValue	String	2000	边缘节点全球（不包含中国内地）HTTPS带宽。当按区域运营商查询时，此值为空。
HttpsValue	String	11288111	边缘节点HTTPS的带宽数据值。单位：bit/s。
OverseasValue	String	2000	全球（不包含中国内地）带宽。当按区域运营商查询时，此值为空。
TimeStamp	String	2015-12-10T20:00:00Z	时间片起始时刻。
Value	String	11288111	带宽。单位：bit/s。
DataInterval	String	300	每条记录的时间间隔。单位：秒。
DomainName	String	example.com	加速域名。
EndTime	String	2015-12-10T20:00Z	结束时间。
IspNameEn	String	unicom	运营商英文名。
LocationNameEn	String	beijing	地域英文名。
RequestId	String	3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F	请求ID。
StartTime	String	2020-05-14T09:50:00Z	开始时间。

示例

请求示例

http://cdn.aliyuncs.com?Action=DescribeDomainBpsData
&DomainName=example.com
&StartTime=2020-05-14T09:50:00Z
&EndTime=2020-05-14T10:00:00Z
&<公共请求参数>

正常返回示例

XML 格式

<DescribeDomainBpsDataResponse>
	  <BpsDataPerInterval>
		    <DataModule>
			      <DomesticValue>11286111</DomesticValue>
			      <HttpsDomesticValue>11288111</HttpsDomesticValue>
			      <HttpsOverseasValue>2000</HttpsOverseasValue>
			      <HttpsValue>11288111</HttpsValue>
			      <OverseasValue>2000</OverseasValue>
			      <TimeStamp>2015-12-10T20:00:00Z</TimeStamp>
			      <Value>11288111</Value>
		    </DataModule>
	  </BpsDataPerInterval>
	  <DataInterval>300</DataInterval>
	  <DomainName>test.com</DomainName>
	  <EndTime>2015-12-10T21:00Z</EndTime>
	  <IspNameEn>unicom</IspNameEn>
	  <LocationNameEn>beijing</LocationNameEn>
	  <RequestId>3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F</RequestId>
	  <StartTime>2015-12-10T20:00Z</StartTime>	
</DescribeDomainBpsDataResponse>

JSON 格式

{
	"RequestId": "0AD87822-E8CE-436B-B434-C13F53B5B2D4",
	"EndTime": "2020-05-14T10:00:00Z",
	"DataInterval": 300,
	"StartTime": "2020-05-14T09:50:00Z",
	"BpsDataPerInterval": {
		"DataModule": [
			{
				"OverseasValue": 0,
				"HttpsValue": 0,
				"Value": "83.48266666666667",
				"HttpsDomesticValue": 0,
				"TimeStamp": "2020-05-14T09:50:00Z",
				"HttpsOverseasValue": 0,
				"DomesticValue": "83.48266666666667"
			},
			{
				"OverseasValue": 0,
				"HttpsValue": 0,
				"Value": 83.424,
				"HttpsDomesticValue": 0,
				"TimeStamp": "2020-05-14T09:55:00Z",
				"HttpsOverseasValue": 0,
				"DomesticValue": 83.424
			}
		]
	}
}

错误码


HttpCode	错误码	错误信息	描述
400	InvalidStartTime.Malformed	Specified StartTime is malformed.	起始时间格式错误。日期格式请参考所调用API的帮助文档说明。
400	InvalidEndTime.Malformed	Specified EndTime is malformed.	结束时间格式错误。日期格式请参考所调用API的帮助文档说明。
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.	开始时间设置错误，请检查更新后重试。

访问错误中心查看更多错误码。