文档

查询推流域名实时流粒度带宽流量数据

调用DescribeLiveStreamPushMetricDetailData查询推流域名实时流粒度推流带宽及流量监控数据。

使用说明

  • 仅支持单个域名查询,多个域名会报错。
  • 数据最大查询跨度:24小时。
  • 数据最小查询粒度:1分钟。
  • 数据最大查询范围:31天。
  • 本接口为监控数据接口,数据采集处理方式不同于计费,不能用于计算用量进行对账参考。

QPS限制

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

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String DescribeLiveStreamPushMetricDetailData

系统规定参数。取值:DescribeLiveStreamPushMetricDetailData

DomainName String example.com
  • 需要查询的加速域名。仅支持单个域名查询,传多个域名将报错。
  • 不指定AppName和StreamName时,按指定加速域名返回此域名下所有流粒度的数据,所有查询数据不聚合。
  • DomainName不为空且AppName为all和StreamName为all时,返回指定加速域名下所有流粒度的聚合数据。
StartTime String 2022-09-10T20:00:00Z

获取数据起始时间点,日期格式按照ISO8601表示法,并使用UTC时间。

格式为:YYYY-MM-DDThh:mm:ssZ。

EndTime String 2022-09-10T21:00:00Z

获取数据结束时间点,日期格式按照ISO8601表示法,并使用UTC时间,结束时间需大于起始时间,且不能相差超过1天。

格式为:YYYY-MM-DDThh:mm:ssZ。

AppName String liveApp****

直播流所属应用名称。指定应用名称,查询对应应用流粒度的数据。

StreamName String liveStream****

直播流名称。指定StreamName时,按指定AppName的指定StreamName,返回流粒度的数据(指定StreamName时,必须指定AppName)。

NextPageToken String UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=

分页查询token,每次查询最多返回5000行数据,当要查询的数据超过5000行时,响应数据会提供下次查询数据的起始索引。

请求时传入该token,将从上一次查询结束的下一行继续查询未获取的数据。

返回数据

名称

类型

示例值

描述

DomainName String example.com

加速域名信息。

EndTime String 2022-09-10T21:00:00Z

获取数据结束时间点,日期格式按照ISO8601表示法,并使用UTC时间。

格式为:YYYY-MM-DDThh:mm:ssZ。

NextPageToken String UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=

分页查询token,每次查询最多返回5000行数据,当要查询的数据超过5000行时,响应数据会提供下次查询数据的起始索引。

请求时传入该token,将从上一次查询结束的下一行继续查询未获取的数据。

PageSize Integer 5000

返回数据行数。

RequestId String 5EBF2AC3-4B73-40A5-8B32-83F49D5F035E

请求ID。

StartTime String 2022-09-10T20:00:00Z

获取数据起始时间点,日期格式按照ISO8601表示法,并使用UTC时间。

格式为:YYYY-MM-DDThh:mm:ssZ。

StreamDetailData Array of StreamData

返回数据组。

StreamData
AppName String liveApp****

应用名称。

ReqBps Float 133.33

流每分钟总带宽,单位:Bps。

ReqTraffic Long 1000

流每分钟总流量,单位:Byte。

StreamName String liveStream****

流名称。

TimeStamp String 2022-09-10T20:00:00Z

时间片起始时刻。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=DescribeLiveStreamPushMetricDetailData
&DomainName=example.com
&StartTime=2022-09-10T20:00:00Z
&EndTime=2022-09-10T21:00:00Z
&AppName=liveApp****
&StreamName=liveStream****
&NextPageToken=UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeLiveStreamPushMetricDetailDataResponse>
    <DomainName>example.com</DomainName>
    <EndTime>2022-09-10T21:00:00Z</EndTime>
    <NextPageToken>UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=</NextPageToken>
    <PageSize>5000</PageSize>
    <RequestId>5EBF2AC3-4B73-40A5-8B32-83F49D5F035E</RequestId>
    <StartTime>2022-09-10T20:00:00Z</StartTime>
    <StreamDetailData>
        <AppName>liveApp****</AppName>
        <ReqBps>133.33</ReqBps>
        <ReqTraffic>1000</ReqTraffic>
        <StreamName>liveStream****</StreamName>
        <TimeStamp>2022-09-10T20:00:00Z</TimeStamp>
    </StreamDetailData>
</DescribeLiveStreamPushMetricDetailDataResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DomainName" : "example.com",
  "EndTime" : "2022-09-10T21:00:00Z",
  "NextPageToken" : "UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=",
  "PageSize" : 5000,
  "RequestId" : "5EBF2AC3-4B73-40A5-8B32-83F49D5F035E",
  "StartTime" : "2022-09-10T20:00:00Z",
  "StreamDetailData" : {
    "AppName" : "liveApp****",
    "ReqBps" : 133.33,
    "ReqTraffic" : 1000,
    "StreamName" : "liveStream****",
    "TimeStamp" : "2022-09-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. 结束时间与开始时间不匹配,请您确认时间的匹配度。
400 InvalidTimeSpan The time span exceeds the limit. 时间跨度超过限制,请参照接口文档,配置合理查询跨度。
400 InvalidPageToken The token of page is invalid. 指定的分页token错误,请传入上次查询返回的正确索引,并确认没有修改您的请求参数。
400 InvalidAppName.Mismatch The AppName param must be passed. AppName参数不匹配,请确认传入了正确的AppName参数。
400 InvalidStreamProtocol.NotSupport The specified stream protocol is not support. 指定的流协议不支持,请参照文档查询所需的流协议。
400 InvalidStreamName.LengthTooLong The specified stream name is too long. StreamName的长度超过限制,请传入合法的StreamName。
400 InvalidAppName.LengthTooLong The specified app name is too long. AppName的长度超过限制,请传入合法的AppName。
400 InvalidTime.ValueNotSupported Specified Time is malformed. 开始时间和结束时间不匹配。

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