DescribeVsDomainBpsData - 查询域名网络带宽监控数据

查询域名网络带宽监控数据。

调试

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

授权信息

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

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

请求参数

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

域名,若参数为空,默认返回所有加速域名合并后数据
可输入需要查询的加速域名
支持批量域名查询,多个域名用逗号(半角)分隔

example.aliyundoc.com
StartTimestring

获取数据起始时间点,日期格式按照 ISO8601 表示法,并使用 UTC 时间。
格式为:YYYY-MM-DDThh:mm:ssZ
最小数据粒度为 5 分钟
不写默认读取过去 24 小时数据

2021-12-26T16:00:00Z
EndTimestring

结束时间需大于起始时间;获日期格式按照 ISO8601 表示法,并使用 UTC 时间。
格式为:YYYY-MM-DDThh:mm:ssZ

2021-10-02T02:30:48Z
Intervalstring

查询数据的时间粒度,支持 300, 3600 和 86400 秒。不传和传的值不支持时,使用默认值 300 秒

300
IspNameEnstring

运营商英文名,通过 DescribeCdnRegionAndIsp 接口获得,不传为所有运营商

unicom
LocationNameEnstring

区域英文名,通过 DescribeCdnRegionAndIsp 接口获得,不传为所有区域

guangdong

返回参数

名称类型描述示例值
object
EndTimestring

结束时间

2021-10-01T07:10:48Z
StartTimestring

开始时间

2021-09-18T16:00:00Z
RequestIdstring

本次操作请求 ID

BEA5625F-8FCF-48F4-851B-CA63946DA664
DomainNamestring

域名

example.aliyundoc.com
DataIntervalstring

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

2100
BpsDataPerIntervalarray<object>

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

DataModuleobject

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

BpsValuestring

bps 数据值,单位:bit/second

1000
TimeStampstring

时间片起始时刻。

2015-12-10T20:00:00Z

示例

正常返回示例

JSON格式

{
  "EndTime": "2021-10-01T07:10:48Z",
  "StartTime": "2021-09-18T16:00:00Z",
  "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
  "DomainName": "example.aliyundoc.com",
  "DataInterval": "2100",
  "BpsDataPerInterval": {
    "DataModule": [
      {
        "BpsValue": "1000",
        "TimeStamp": "2015-12-10T20:00:00Z"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidStartTime.MalformedThe format of the specified StartTime is invalid.开始时间格式不对
400InvalidEndTime.MalformedThe format of the specified EndTime is invalid.截止时间格式不对
400InvalidEndTime.MismatchThe specified EndTime is earlier than the StartTime.结束时间早于开始时间,请检查
400InvalidStartTime.ValueNotSupportedThe specified StartTime is invalid.不支持该开始时间

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