DescribeDcdnDomainWebsocketBpsData - 查询WebSocket的带宽数据

更新时间:

调用DescribeDcdnDomainWebsocketBpsData查询域名WebSocket协议的网络带宽监控数据。

接口说明

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

支持查询的时间粒度

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

时间粒度单次查询的最大时间跨度可查询历史数据时间范围数据延迟
5 分钟3 天93 天15 分钟
1 小时31 天186 天一般延迟 3-4 小时
1 天366 天366 天一般延迟 4 小时,不超过 24 小时

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
DomainNamestring

加速域名。

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

example.com
StartTimestring

获取数据的起始时间点。

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

2017-12-10T20:00:00Z
EndTimestring

获取数据的结束时间点。

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

说明 结束时间需大于起始时间。
2017-12-10T21:00:00Z
Intervalstring

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

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

300
IspNameEnstring

运营商英文名。

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

unicom
LocationNameEnstring

地域商英文名。

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

beijing

返回参数

名称类型描述示例值
object
EndTimestring

结束时间。

2017-12-10T21:00:00Z
StartTimestring

开始时间。

2017-12-10T20:00:00Z
RequestIdstring

请求 ID。

3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F
DomainNamestring

加速域名信息。

example.com
DataIntervalstring

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

300
BpsDataPerIntervalarray<object>

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

DataModuleobject
TimeStampstring

时间片起始时刻。

2017-12-10T20:00:00Z
WebsocketBpsfloat

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

11288111

示例

正常返回示例

JSON格式

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

错误码

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

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