全部产品
Search
文档中心

全站加速 DCDN:DescribeDcdnBgpBpsData - 查询BGP带宽数据

更新时间:Apr 11, 2024

调用DescribeDcdnBgpBpsData查询BGP加速五分钟粒度带宽数据。

接口说明

  • 不指定 StartTime 和 EndTime 时,该接口默认读取过去 24 小时的数据,同时支持按指定的起止时间查询,两者需要同时指定。
  • 指定多条线路时数据聚合处理。
  • 最多可获取最近 90 天的数据。
  • StartTime 和 EndTime 最大支持 31 天跨度。
  • 数据跨度 72 小时内(包含)可以支持 5 分钟粒度,72 小时以上只支持小时粒度。
  • 单用户调用频率:5 次/秒。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dcdn:DescribeDcdnBgpBpsDataRead
  • 全部资源
    *

请求参数

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

需要查询的线路,查询多条路线用英文逗号(,)分隔。指定多条线路时进行聚合处理,默认为所有线路.。

可选值:

  • cu:联通。
  • cmi:移动。
  • ct:电信。
cu
StartTimestring

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

最小数据粒度为 1 小时。

默认读取过去 24 小时数据。

2018-11-29T00:00:00Z
EndTimestring

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

2018-11-30T00:00:00Z
Intervalstring

数据粒度,支持 300 秒和 3600 秒,默认为 300 秒即五分钟,但需要和时间跨度综合判定。

300
DeviceNamestring

设备名称。若指定则返回对应设备的数据,,不指定则为所有设备合并。

devicename
DevicePortstring

设备端口。若指定则返回对应设备端口的数据,不指定则为所有端口。该字段必须在指定了 DeviceName 的时候才可以生效。

123

返回参数

名称类型描述示例值
object
EndTimestring

结束时间。

2018-11-30T00:00:00Z
StartTimestring

开始时间。

2018-11-29T00:00:00Z
RequestIdstring

请求 ID。

E9D3257A-1B7C-414C-90C1-8D07AC47BCAC
BgpDataIntervalobject []

每个时间间隔的 BGP 带宽情况。

Outfloat

出向带宽,单位:Bps。

183
Infloat

入向带宽,单位:Bps。

318
TimeStampstring

时间片起始时刻。

2018-11-29T20:00:00Z

示例

正常返回示例

JSON格式

{
  "EndTime": "2018-11-30T00:00:00Z",
  "StartTime": "2018-11-29T00:00:00Z",
  "RequestId": "E9D3257A-1B7C-414C-90C1-8D07AC47BCAC",
  "BgpDataInterval": [
    {
      "Out": 183,
      "In": 318,
      "TimeStamp": "2018-11-29T20:00:00Z"
    }
  ]
}

错误码

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.不支持该开始时间,请重新填写。

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