首页 视频直播 开发参考 API参考(新) API目录 监控统计 DescribeLiveDomainPushBpsData - 查询推流域名推流网络带宽监控数据

DescribeLiveDomainPushBpsData - 查询推流域名推流网络带宽监控数据

更新时间: 2024-12-24 14:34:49

调用DescribeLiveDomainPushBpsData获取推流域名的推流网络带宽监控数据。

接口说明

  • 获取的带宽数据单位为 bit/s。
  • 支持批量域名查询,多个域名用英文逗号(,)分隔。
  • 不指定 StartTime 和 EndTime 时,默认读取过去 24 小时的数据,同时支持按指定的起止时间查询,两者需要同时指定。
  • 最多可获取最近 90 天的数据。

QPS 限制

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

调试

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

授权信息

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

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

请求参数

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

推流域名。 支持批量域名查询,多个域名用英文逗号(,)分隔。 若参数为空,默认返回所有推流域名合并后数据。

demo.aliyundoc.com
StartTimestring

起始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 不写默认读取过去 24 小时数据。

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

结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 结束时间需大于起始时间。

2017-12-10T21:00:00Z
Intervalstring

查询数据的时间粒度。单位:秒。取值:

  • 300
  • 3600
  • 86400

不传和传的值不支持时,使用默认值 300 秒。

300
IspNameEnstring

运营商英文名. 可通过 DescribeCdnRegionAndIsp 接口获得,不传默认为所有运营商。

alibaba
LocationNameEnstring

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

tianjin

返回参数

名称类型描述示例值
object
EndTimestring

结束时间。

2017-12-10T21:00:00Z
StartTimestring

开始时间。

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

请求 ID。

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

查询的推流域名。

demo.aliyundoc.com
DataIntervalstring

所查询数据的时间粒度。

300
BpsDataPerIntervalarray<object>

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

DataModuleobject
BpsValuestring

bps 数据值。单位:bit/s。

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": "demo.aliyundoc.com",
  "DataInterval": "300",
  "BpsDataPerInterval": {
    "DataModule": [
      {
        "BpsValue": "11288111",
        "TimeStamp": "2017-12-10T20:00:00Z"
      }
    ]
  }
}

错误码

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

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

上一篇: DescribeLiveDomainBpsDataByLayer - 按协议分类查询域名带宽及流量数据 下一篇: DescribeLiveDomainPushTrafficData - 查询推流域名推流流量监控数据
阿里云首页 视频直播 相关技术圈