文档

查询域名推流回调记录

调用DescribeLiveStreamsNotifyRecords查询域名推流回调记录。

QPS限制

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

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String DescribeLiveStreamsNotifyRecords

系统规定参数。取值:DescribeLiveStreamsNotifyRecords

DomainName String push.example1.com

推流域名。

AppName String app

直播流所属应用名称。

StreamName String stream

直播流名称。

Status String success

回调是否成功。

  • success:成功。
  • failed:失败。
StartTime String 2017-12-10T08:00:00Z

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

说明 开始时间必须在近7天内。
EndTime String 2017-12-10T09:00:00Z

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

PageSize Integer 20

分页大小,默认20,最大500。取值:1~500之前的任意整数。

PageNumber Integer 1

分页的页数,默认值为1。

返回数据

名称

类型

示例值

描述

NotifyRecordsInfo Array of LiveStreamNotifyRecordsInfo

推流回调记录。

LiveStreamNotifyRecordsInfo
AppName String app

直播流所属应用名称。

Description String success

结果描述,为success时成功,失败则返回错误信息。

DomainName String push.example1.com

推流域名。

NotifyContent String {\"action\":\"publish_done\",\"app\":\"push.example1.com\"}

回调的具体内容。

NotifyResult String success

回调结果。

  • success:成功。
  • failed:失败。
NotifyTime String 2022-10-19T19:09:28Z

回调发生时间(UTC时间)。

NotifyType String publish_done

回调类型。

  • publish:表示推流事件。
  • publish_done:表示断流事件。
NotifyUrl String http://xx.xx.xx.xx/callbacks

回调URL。

StreamName String stream

直播流名称。

PageNum Integer 1

分页页码。

PageSize Integer 20

每页大小。

RequestId String F675E4B4-125D-1533-901B-11A724644285

请求ID。

TotalNum Integer 20

符合条件的总个数。

TotalPage Integer 20

总页数。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=DescribeLiveStreamsNotifyRecords
&DomainName=push.example1.com
&AppName=app
&StreamName=stream
&Status=success
&StartTime=2017-12-10T08:00:00Z
&EndTime=2017-12-10T09:00:00Z
&PageSize=20
&PageNumber=1
&公共请求参数

正常返回示例

XML格式

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

<DescribeLiveStreamsNotifyRecordsResponse>
    <NotifyRecordsInfo>
        <AppName>app</AppName>
        <Description>success</Description>
        <DomainName>push.example1.com</DomainName>
        <NotifyContent>{\"action\":\"publish_done\",\"app\":\"push.example1.com\"}</NotifyContent>
        <NotifyResult>success</NotifyResult>
        <NotifyTime>2022-10-19T19:09:28Z</NotifyTime>
        <NotifyType>publish_done</NotifyType>
        <NotifyUrl>http://xx.xx.xx.xx/callbacks</NotifyUrl>
        <StreamName>stream</StreamName>
    </NotifyRecordsInfo>
    <PageNum>1</PageNum>
    <PageSize>20</PageSize>
    <RequestId>F675E4B4-125D-1533-901B-11A724644285</RequestId>
    <TotalNum>20</TotalNum>
    <TotalPage>20</TotalPage>
</DescribeLiveStreamsNotifyRecordsResponse>

JSON格式

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

{
  "NotifyRecordsInfo" : [ {
    "AppName" : "app",
    "Description" : "success",
    "DomainName" : "push.example1.com",
    "NotifyContent" : "{\\\"action\\\":\\\"publish_done\\\",\\\"app\\\":\\\"push.example1.com\\\"}",
    "NotifyResult" : "success",
    "NotifyTime" : "2022-10-19T19:09:28Z",
    "NotifyType" : "publish_done",
    "NotifyUrl" : "http://xx.xx.xx.xx/callbacks",
    "StreamName" : "stream"
  } ],
  "PageNum" : 1,
  "PageSize" : 20,
  "RequestId" : "F675E4B4-125D-1533-901B-11A724644285",
  "TotalNum" : 20,
  "TotalPage" : 20
}

错误码

HttpCode

错误码

错误信息

描述

400 InvalidStartTime.Malformed Specified parameter StartTime is not valid. StartTime参数错误,请您确认该StartTime参数是否正确。
400 InvalidEndTime.Malformed Specified parameter EndTime is not valid. 结束时间错误,请您确认结束时间是否正确。

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