文档

DescribeDcdnDomainIpaBpsData - 获取四层加速的带宽数据

更新时间:

调用DescribeDcdnDomainIpaBpsData获取加速域名四层加速的网络带宽监控数据,支持获取最近90天的数据。

接口说明

  • 该接口获取数据的单位为:bit/second。
  • 不指定 StartTimeEndTime,默认返回过去 24 小时的数据;指定 StartTimeEndTime,返回指定起止时间的数据。
  • 单用户调用频率:100 次/秒。

调试

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

授权信息

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

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

请求参数

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

加速域名。

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

example.com
StartTimestring

获取数据的起始时间点。

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

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

获取数据的结束时间点。

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

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

是否自适应计算 Interval 值,如果 timeMerge=1,会根据 startTimeendTime 计算出合适的 inteval 值,和 Interval 参数任选。

1
Intervalstring

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

根据您指定 StartTimeEndTime 两者的时间跨度,该参数取值如下:

  • 3 天以内(不包含 3 天整):支持 300360086400,如果不传该参数,默认值为 300

  • 3~31 天(不包含 31 天整):支持 360086400,如果不传该参数,默认值为 3600

  • 31 天及以上:支持 86400,如果不传该参数,默认值为 86400

300
FixTimeGapstring

是否补零。取值:

  • true:补零。
  • false:不补零。
false
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
BpsDataPerIntervalobject []

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

IpaBpsfloat

带宽数据值,单位:bit/second。

11288111
TimeStampstring

时间片起始时刻。

2017-12-10T20:00:00Z

示例

正常返回示例

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": [
      {
        "IpaBps": 11288111,
        "TimeStamp": "2017-12-10T20:00:00Z"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400MissingTimeParameterThe StartTime and EndTime must be both specified.请同时提供开始时间和结束时间。
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.不支持该开始时间,请重新填写。

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

  • 本页导读 (1)
文档反馈