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

使用说明

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

QPS限制

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeLiveDomainBpsData

系统规定参数。取值:DescribeLiveDomainBpsData

DomainName String example.com

播流域名。多个域名之间用英文逗号(,)分隔。

StartTime String 2017-12-10T08:00:00Z

起始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

EndTime String 2017-12-10T09:00:00Z

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

Interval String 300

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

  • 300(默认值)
  • 3600
  • 86400
说明
  • 不传或传值不支持时,取默认值300
  • 查询时间粒度为300时,返回的bps数据值为300秒内平均每秒传输的bit。
  • 查询时间粒度为360086400时,返回的bps数据值为查询时间内所有300秒取值点的峰值。
LocationNameEn String tianjin

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

IspNameEn String alibaba

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

RegionId String cn-shanghai

地域ID。

返回数据

名称 类型 示例值 描述
DomainName String example.com

播流域名。

DataInterval String 300

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

BpsDataPerInterval Array of DataModule

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

DataModule
TimeStamp String 2017-12-10T08:00:05Z

时间片起始时刻。

BpsValue String 11288111

bps数据值,单位:bit/second。

HttpBpsValue String 11286111

HTTP的bps数据值,单位:bit/second。

HttpsBpsValue String 2000

HTTPS的bps数据值,单位:bit/second。

RequestId String B955107D-E658-4E77-B913-E0AC3D31693E

请求ID。

StartTime String 2017-12-10T08:00:00Z

开始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

EndTime String 2017-12-10T09:00:00Z

结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=DescribeLiveDomainBpsData
&<公共请求参数>

正常返回示例

XML格式

<DescribeLiveDomainBpsDataResponse>
  <EndTime>2017-12-10T09:00:00Z</EndTime>
  <RequestId>B955107D-E658-4E77-B913-E0AC3D31693E</RequestId>
  <DomainName>example.com</DomainName>
  <DataInterval>300</DataInterval>
  <StartTime>2017-12-10T08:00:00Z</StartTime>
  <BpsDataPerInterval>
        <DataModule>
              <HttpsBpsValue>2000</HttpsBpsValue>
              <BpsValue>11288111</BpsValue>
              <HttpBpsValue>11286111</HttpBpsValue>
              <TimeStamp>2017-12-10T08:00:05Z</TimeStamp>
        </DataModule>
  </BpsDataPerInterval>
</DescribeLiveDomainBpsDataResponse>

JSON格式

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

错误码

HttpCode 错误码 错误信息 描述
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. 结束时间与开始时间不匹配,请您确认时间的匹配度。

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