全部产品
Search
文档中心

CDN:DescribeDomainBpsData - 查询带宽

更新时间:May 30, 2023

调用DescribeDomainBpsData查询带宽数据。

接口说明

  • 单用户调用频率:150次/秒。
  • 如果您不指定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代码示例。

调试

授权信息

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

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

请求参数

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

加速域名,多个域名使用半角逗号(,)分隔,一次最多支持500个域名查询。

默认查询所有加速域名。

example.com
StartTimestring

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

2020-05-14T09:50:00Z
EndTimestring

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

说明结束时间需大于起始时间。
2020-05-14T10:00:00Z
Intervalstring

指定查询数据的时间粒度,单位:秒。

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

300
IspNameEnstring

运营商英文名,通过DescribeCdnRegionAndIsp接口获得。

默认查询所有运营商。

telecom
LocationNameEnstring

地域英文名,通过DescribeCdnRegionAndIsp接口获得。

默认查询所有地域。

beijing

返回参数

名称类型描述示例值
object
EndTimestring

结束时间。

2015-12-10T20:00Z
StartTimestring

开始时间。

2020-05-14T09:50:00Z
RequestIdstring

请求ID。

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

运营商英文名。

unicom
LocationNameEnstring

地域英文名。

beijing
DomainNamestring

加速域名。

example.com
DataIntervalstring

每条记录的时间间隔。单位:秒。

300
BpsDataPerIntervalobject []

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

HttpsDomesticValuestring

边缘节点HTTPS中国内地带宽。当按区域运营商查询时,此值为空。

11286111
Valuestring

带宽。单位:bit/s。

11288111
OverseasValuestring

全球(不包含中国内地)带宽。当按区域运营商查询时,此值为空。

2000
HttpsValuestring

边缘节点HTTPS的带宽数据值。单位:bit/s。

11288111
HttpsOverseasValuestring

边缘节点全球(不包含中国内地)HTTPS带宽。当按区域运营商查询时,此值为空。

2000
TimeStampstring

时间片起始时刻。

2015-12-10T20:00:00Z
DomesticValuestring

中国内地带宽。当按区域运营商查询时,此值为空。

11286111

示例

正常返回示例

JSON格式

{
  "EndTime": "2015-12-10T20:00Z",
  "StartTime": "2020-05-14T09:50:00Z",
  "RequestId": "3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F",
  "IspNameEn": "unicom",
  "LocationNameEn": "beijing",
  "DomainName": "example.com",
  "DataInterval": "300",
  "BpsDataPerInterval": {
    "DataModule": [
      {
        "HttpsDomesticValue": "11286111",
        "Value": "11288111",
        "OverseasValue": "2000",
        "HttpsValue": "11288111",
        "HttpsOverseasValue": "2000",
        "TimeStamp": "2015-12-10T20:00:00Z",
        "DomesticValue": "11286111"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidStartTime.MalformedSpecified StartTime is malformed.起始时间格式错误。日期格式请参考所调用API的帮助文档说明。
400InvalidEndTime.MalformedSpecified EndTime is malformed.结束时间格式错误。请核对后重新提供。
400InvalidStartTime.ValueNotSupportedThe specified value of parameter StartTime is not supported.开始时间设置错误,请检查更新后重试。
400InvalidEndTime.MismatchThe specified EndTime is earlier than the StartTime.-
404InvalidDomain.NotFoundThe domain [%s] does not belong to you.-

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