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

调用DescribeLiveDomainBpsData查询直播域名的网络带宽监控数据。

接口说明

不指定 StartTime 和 EndTime 时，默认读取过去 24 小时的数据，同时支持按指定的起止时间查询，两者需要同时指定。
仅指定 StartTime，未指定 EndTime 时，读取从 StartTime 开始 1 小时之内的数据。
仅指定 EndTime，未指定 StartTime 时，读取从 EndTime 向前 1 小时之内的数据。
支持最长可查询最近 90 天的数据。
本接口为监控数据接口，数据采集处理方式不同于计费，不能用于计算用量进行对账参考。

QPS 限制

本接口的单用户 QPS 限制为 100 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
live:DescribeLiveDomainBpsData	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
DomainName	string	否	播流域名。支持单个或批量域名查询。批量查询时多个域名用英文逗号（,）分隔。若参数为空，默认返回所有直播域名合并后的数据。	example.com
StartTime	string	否	起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2017-12-10T08:00:00Z
EndTime	string	否	结束时间。结束时间需晚于起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2017-12-10T09:00:00Z
Interval	string	否	查询数据的时间粒度。单位：秒。取值： 300（默认值） 3600 86400 说明不传或传值不支持时，取默认值 300。查询时间粒度为 300 时，返回的 bps 数据值为 300 秒内平均每秒传输的 bit。查询时间粒度为 3600 和 86400 时，返回的 bps 数据值为查询时间内所有 300 秒取值点的峰值。	300
IspNameEn	string	否	运营商英文名。通过 DescribeCdnRegionAndIsp 接口获得。	alibaba
LocationNameEn	string	否	区域英文名。通过 DescribeCdnRegionAndIsp 接口获得。	tianjin

返回参数

名称	类型	描述	示例值
	object
EndTime	string	结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2017-12-10T09:00:00Z
StartTime	string	开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2017-12-10T08:00:00Z
RequestId	string	请求 ID。	B955107D-E658-4E77-B913-E0AC3D31693E
DomainName	string	播流域名。	example.com
DataInterval	string	查询数据的时间粒度，单位是秒。	300
BpsDataPerInterval	array<object>	每个时间间隔的网络带宽数据。
DataModule	object	每个时间间隔的网络带宽数据。
BpsValue	string	bps 数据值，单位：bit/second。	11288111
TimeStamp	string	时间片起始时刻。	2017-12-10T08:00:05Z
HttpsBpsValue	string	HTTPS 的 bps 数据值，单位：bit/second。	2000
HttpBpsValue	string	HTTP 的 bps 数据值，单位：bit/second。	11286111

示例

正常返回示例

JSON格式

{
  "EndTime": "2017-12-10T09:00:00Z",
  "StartTime": "2017-12-10T08:00:00Z",
  "RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
  "DomainName": "example.com",
  "DataInterval": "300",
  "BpsDataPerInterval": {
    "DataModule": [
      {
        "BpsValue": "11288111",
        "TimeStamp": "2017-12-10T08:00:05Z",
        "HttpsBpsValue": "2000",
        "HttpBpsValue": "11286111"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidStartTime.Malformed	Specified StartTime is malformed.	StartTime参数错误，请您确认该StartTime参数是否正确。
400	InvalidEndTime.Malformed	Specified EndTime is malformed.	结束时间错误，请您确认结束时间是否正确。
400	InvalidEndTime.Mismatch	Specified end time does not math the specified start time.	结束时间与开始时间不匹配，请您确认时间的匹配度。
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.	传入的StartTime参数不支持。

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

变更历史

变更时间	变更内容概要	操作
2024-09-29	OpenAPI 描述信息更新、OpenAPI 错误码发生变更	查看变更详情