调用DescribeDcdnDomainWebsocketBpsData获取加速域名WebSocket协议的网络带宽监控数据。

使用说明

  • 单用户调用频率:100次/秒。
  • 不指定StartTimeEndTime,默认返回过去24小时的数据;指定StartTimeEndTime,返回指定起止时间的数据。
支持查询的时间粒度

根据单次查询的最大时间跨度不同,请求参数Interval支持不同的查询数据时间粒度,对应的可查询历史数据时间范围和数据延迟如下:

时间粒度

单次查询的最大时间跨度

可查询历史数据时间范围

数据延迟

5分钟

3天

93天

15分钟

1小时

31天

186天

4小时

1天

366天

366天

次日凌晨4点

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDcdnDomainWebsocketBpsData

系统规定参数。取值:DescribeDcdnDomainWebsocketBpsData

DomainName String example.com

加速域名。

多个域名用英文逗号(,)分隔,默认查询所有加速域名。

StartTime String 2017-12-10T20:00:00Z

获取数据的起始时间点。

日期格式按照ISO8601表示法,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。

EndTime String 2017-12-10T21:00:00Z

获取数据的结束时间点。

日期格式按照ISO8601表示法,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。

说明 结束时间需大于起始时间。
Interval String 300

查询数据的时间粒度,单位为秒。

根据单次查询的最大时间跨度不同,该参数支持300(5分钟)、3600(1小时)和86400(1天)取值,具体请参见使用说明中支持查询的时间粒度。

IspNameEn String unicom

运营商英文名。

您可以调用DescribeDcdnRegionAndIsp接口获取,默认查询所有运营商。

LocationNameEn String beijing

地域商英文名。

您可以调用DescribeDcdnRegionAndIsp接口获取,默认查询所有地域。

返回数据

名称 类型 示例值 描述
EndTime String 2017-12-10T21:00:00Z

结束时间。

StartTime String 2017-12-10T20:00:00Z

开始时间。

RequestId String 3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F

请求ID。

DomainName String example.com

加速域名信息。

DataInterval String 300

每条记录的时间间隔,以秒为单位。

BpsDataPerInterval Array of DataModule

每个时间间隔的网络带宽数据。

DataModule
TimeStamp String 2017-12-10T20:00:00Z

时间片起始时刻。

WebsocketBps Float 11288111

bps数据值,单位:bit/s。

示例

请求示例

http(s)://dcdn.aliyuncs.com/?Action=DescribeDcdnDomainWebsocketBpsData
&DomainName=example.com
&StartTime=2017-12-10T20:00:00Z
&EndTime=2017-12-10T21:00:00Z
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDcdnDomainWebsocketBpsDataResponse>
	<BpsDataPerInterval>
		<DataModule>
			<TimeStamp>2017-12-10T20:00:00Z</TimeStamp>
			<WebsocketBps>11288111</WebsocketBps>
		</DataModule>
		<DataModule>
			<TimeStamp>2017-12-10T20:05:00Z</TimeStamp>
			<WebsocketBps>11288111</WebsocketBps>
		</DataModule>
	</BpsDataPerInterval>
	<DomainName>example.com</DomainName>
	<DataInterval>300</DataInterval>
	<RequestId>3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F</RequestId>
	<StartTime>2017-12-10T20:00:00Z</StartTime>
	<EndTime>2017-12-10T21:00:00Z</EndTime>
</DescribeDcdnDomainWebsocketBpsDataResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "BpsDataPerInterval" : {
    "DataModule" : [ {
      "TimeStamp" : "2017-12-10T20:00:00Z",
      "WebsocketBps" : 11288111
    }, {
      "TimeStamp" : "2017-12-10T20:05:00Z",
      "WebsocketBps" : 11288111
    } ]
  },
  "DomainName" : "example.com",
  "DataInterval" : "300",
  "RequestId" : "3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F",
  "StartTime" : "2017-12-10T20:00:00Z",
  "EndTime" : "2017-12-10T21:00:00Z"
}

错误码

HttpCode 错误码 错误信息 描述
400 MissingTimeParameter The StartTime and EndTime must be both specified. 请同时提供开始时间和结束时间。
400 InvalidEndTime.Malformed The specified EndTime is invalid. 请提供正确的结束时间格式。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:yyyy-MM-ddTHH:mm:ssZ。
400 InvalidEndTime.Mismatch The specified EndTime is earlier than the StartTime. 结束时间早于开始时间,请检查。
400 InvalidStartTime.ValueNotSupported The specified StartTime is invalid. 不支持该开始时间,请重新填写。

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