调用DescribeLiveDomainPushBpsData获取推流域名的推流网络带宽监控数据。
使用说明
- 获取的带宽数据单位为bit/s。
- 支持批量域名查询,多个域名用英文逗号(,)分隔。
- 不指定StartTime和EndTime时,默认读取过去24小时的数据,同时支持按指定的起止时间查询,两者需要同时指定。
- 最多可获取最近90天的数据。
QPS限制
本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeLiveDomainPushBpsData |
系统规定参数。取值: DescribeLiveDomainPushBpsData。 |
RegionId | String | 否 | cn-shanghai |
域名所属地域。 |
DomainName | String | 否 | demo.aliyundoc.com |
推流域名。 支持批量域名查询,多个域名用英文逗号(,)分隔。 若参数为空,默认返回所有推流域名合并后数据。 |
StartTime | String | 否 | 2017-12-10T20:00:00Z |
起始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 不写默认读取过去24小时数据。 |
EndTime | String | 否 | 2017-12-10T21:00:00Z |
结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 结束时间需大于起始时间。 |
Interval | String | 否 | 300 |
查询数据的时间粒度。单位:秒。取值:
不传和传的值不支持时,使用默认值300秒。 |
IspNameEn | String | 否 | alibaba |
运营商英文名. 可通过DescribeCdnRegionAndIsp接口获得,不传默认为所有运营商。 |
LocationNameEn | String | 否 | tianjin |
区域英文名。 可通过DescribeCdnRegionAndIsp接口获得,不传默认为所有区域。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
BpsDataPerInterval | Array of DataModule |
每个时间间隔的网络带宽数据。 |
|
DataModule | |||
BpsValue | String | 11288111 |
bps数据值。单位:bit/s。 |
TimeStamp | String | 2017-12-10T20:00:00Z |
时间片起始时刻。 |
DataInterval | String | 300 |
所查询数据的时间粒度。 |
DomainName | String | demo.aliyundoc.com |
查询的推流域名。 |
EndTime | String | 2017-12-10T21:00:00Z |
结束时间。 |
RequestId | String | 3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F |
请求ID。 |
StartTime | String | 2017-12-10T20:00:00Z |
开始时间。 |
示例
请求示例
http(s)://live.aliyuncs.com/?Action=DescribeLiveDomainPushBpsData
&<公共请求参数>
正常返回示例
XML
格式
<DescribeLiveDomainPushBpsDataResponse>
<EndTime>2017-12-10T21:00:00Z</EndTime>
<RequestId>3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F</RequestId>
<DomainName>demo.aliyundoc.com</DomainName>
<DataInterval>300</DataInterval>
<StartTime>2017-12-10T20:00:00Z</StartTime>
<BpsDataPerInterval>
<DataModule>
<BpsValue>11288111</BpsValue>
<TimeStamp>2017-12-10T20:00:00Z</TimeStamp>
</DataModule>
</BpsDataPerInterval>
</DescribeLiveDomainPushBpsDataResponse>
JSON
格式
{
"DescribeLiveDomainPushBpsDataResponse": {
"EndTime": "2017-12-10T21:00:00Z",
"RequestId": "3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F",
"DomainName": "demo.aliyundoc.com",
"DataInterval": 300,
"StartTime": "2017-12-10T20:00:00Z",
"BpsDataPerInterval": {
"DataModule": {
"BpsValue": 11288111,
"TimeStamp": "2017-12-10T20:00:00Z"
}
}
}
}
错误码
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. | 结束时间与开始时间不匹配,请您确认时间的匹配度。 |
访问错误中心查看更多错误码。