调用DescribeDcdnDomainWebsocketTrafficData查询域名的WebSocket网络流量监控数据。
接口说明
单用户调用频率:100 次/秒。
不指定 StartTime 和 EndTime,默认返回过去 24 小时的数据;指定 StartTime 和 EndTime,返回指定起止时间的数据。
支持查询的时间粒度
根据单次查询的最大时间跨度不同,请求参数 Interval 支持不同的查询数据时间粒度,对应的可查询历史数据时间范围和数据延迟如下:
时间粒度 | 单次查询的最大时间跨度 | 可查询历史数据时间范围 | 数据延迟 |
5 分钟 | 3 天 | 93 天 | 15 分钟 |
1 小时 | 31 天 | 186 天 | 一般延迟 3-4 小时 |
1 天 | 366 天 | 366 天 | 一般延迟 4 小时,不超过 24 小时 |
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
dcdn:DescribeDcdnDomainWebsocketTrafficData |
get |
*Domain
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
DomainName |
string |
否 |
加速域名。 多个域名用英文逗号(,)分隔,默认查询所有加速域名。 |
example.com |
StartTime |
string |
否 |
获取数据的起始时间点。 日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。 |
2017-12-10T20:00:00Z |
EndTime |
string |
否 |
获取数据的结束时间点。 日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。 说明
结束时间需大于起始时间。 |
2017-12-10T21:00:00Z |
Interval |
string |
否 |
查询数据的时间粒度,单位为秒。 根据单次查询的最大时间跨度不同,该参数支持 300(5 分钟)、3600(1 小时)和 86400(1 天)取值,具体请参见使用说明中支持查询的时间粒度。 |
300 |
IspNameEn |
string |
否 |
运营商英文名。 您可以调用 DescribeDcdnRegionAndIsp 接口获取,默认查询所有运营商。 |
unicom |
LocationNameEn |
string |
否 |
地域商英文名。 您可以调用 DescribeDcdnRegionAndIsp 接口获取,默认查询所有地域。 |
beijing |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
|||
EndTime |
string |
结束时间。 |
2017-12-10T21:00:00Z |
StartTime |
string |
开始时间。 |
2017-12-10T20:00:00Z |
RequestId |
string |
请求 ID。 |
B955107D-E658-4E77-B913-E0AC3D31693E |
DomainName |
string |
加速域名信息。 |
example.com |
DataInterval |
string |
每条记录的时间间隔,以秒为单位。 |
300 |
TrafficDataPerInterval |
object |
||
DataModule |
array<object> |
每个时间间隔的流量数据,单位:Byte。 |
|
object |
|||
WebsocketTraffic |
number |
总流量。 |
423304182 |
TimeStamp |
string |
时间片起始时刻。 |
2017-12-10T20:00:00Z |
示例
正常返回示例
JSON
格式
{
"EndTime": "2017-12-10T21:00:00Z",
"StartTime": "2017-12-10T20:00:00Z",
"RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
"DomainName": "example.com",
"DataInterval": "300",
"TrafficDataPerInterval": {
"DataModule": [
{
"WebsocketTraffic": 423304182,
"TimeStamp": "2017-12-10T20:00:00Z"
}
]
}
}
错误码
HTTP status code |
错误码 |
错误信息 |
描述 |
---|---|---|---|
400 | MissingTimeParameter | The StartTime and EndTime must be both specified. | 请同时提供开始时间和结束时间。 |
400 | InvalidStartTime.Malformed | The specified StartTime parameter is invalid. | 请提供正确的开始时间格式。日期格式按照ISO8601表示法,并使用UTC时间,格式为:yyyy-MM-ddTHH:mm:ssZ。 |
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. | 不支持该开始时间,请重新填写。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。