调用DescribeDcdnDomainWebsocketBpsData获取加速域名websocket协议的网络带宽监控数据,支持获取最近90天的数据。
- 该接口获取数据单位:bit/second。
- 如果您不指定StartTime和EndTime时,默认读取过去24小时的数据,同时支持按指定的起止时间查询,两者需要同时指定。
- 您可以进行批量域名查询,多个域名用逗号(,)分隔。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDcdnDomainWebsocketBpsData |
操作接口名,系统规定参数。取值:DescribeDcdnDomainWebsocketBpsData。 |
DomainName | String | 否 | example.com |
加速域名,多个域名用逗号(,)分隔。 默认查询所有加速域名。 |
StartTime | String | 否 | 2017-12-10T20:00:00Z |
获取数据起始时间点。日期格式按照ISO8601表示法,并使用UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ。 |
EndTime | String | 否 | 2017-12-10T21:00:00Z |
获取数据结束时间点。日期格式按照ISO8601表示法,并使用UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ。 结束时间需大于起始时间。 |
Interval | String | 否 | 300 |
查询数据的时间粒度,单位:秒。根据您指定StartTime和EndTime两者的时间跨度,该参数取值如下:
|
IspNameEn | String | 否 | unicom |
运营商英文名,通过DescribeCdnRegionAndIsp接口获得,默认查询所有运营商。 |
LocationNameEn | String | 否 | beijing |
地域英文名,通过DescribeCdnRegionAndIsp接口获得,默认查询所有地域。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
BpsDataPerInterval | Array |
每个时间间隔的网络带宽数据。 |
|
DataModule | |||
TimeStamp | String | 2017-12-10T20:00:00Z |
时间片起始时刻。 |
WebsocketBps | Float | 11288111 |
bps数据值,单位:bit/second。 |
DataInterval | String | 300 |
每条记录的时间间隔,以秒为单位。 |
DomainName | String | example.com |
加速域名信息。 |
EndTime | String | 2017-12-10T21:00:00Z |
结束时间。 |
RequestId | String | 3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F |
请求ID。 |
StartTime | String | 2017-12-10T20:00:00Z |
开始时间。 |
示例
请求示例
http://dcdn.aliyuncs.com/?Action=DescribeDcdnDomainWebsocketBpsData
&DomainName=example.com
&StartTime=2017-12-10T20:00:00Z
&EndTime=2017-12-10T21:00:00Z
&<公共请求参数>
正常返回示例
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
格式
{
"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. | 不支持该开始时间,请重新填写。 |
访问错误中心查看更多错误码。