查询直播录制回调记录

调用DescribeLiveRecordNotifyRecords查询直播录制存储至OSS的回调记录。

QPS限制

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

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String DescribeLiveRecordNotifyRecords

系统规定参数。取值:DescribeLiveRecordNotifyRecords

DomainName String example.com

主播流域名。

AppName String liveApp****

播流所属应用名称。

StreamName String liveStream****

播流名称。

PageSize Long 10

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

PageNumber Long 1

当前页码。默认值为1。取值范围为:1~100000。

Status String success

回调是否成功。

  • success:成功。
  • failed:失败。
StartTime String 2023-02-10T21:03:47Z

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

说明 支持查询最近7天内的数据。
EndTime String 2023-02-10T21:03:47Z

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

返回数据

名称

类型

示例值

描述

CallbackList Array of Callback

回调记录。

AppName String liveApp****

播流所属应用名称。

Description String success

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

DomainName String example.com

主播流域名。

NotifyContent String 7月26日 16:14{"domain":"al.xxxx.com","stream":"livestream01","pull _stream_result":true,"cdn":"al"}

回调的具体内容。

NotifyResult String success

回调结果。

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

回调时间,格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

NotifyType String record_started

回调种类。

  • file_created:录制文件创建成功。
  • record_error:录制错误。
  • record_started:录制已经成功开始。
  • record_paused:录制已经成功暂停。
  • record_resumed:录制已经成功恢复继续录制。
  • record_force_transcode_fail:录制任务触发转码失败。
  • transformat_error:直播流内容解析出错。
NotifyUrl String http://learn.aliyundoc.com/examplecallback.action

录制回调地址。

StreamName String liveStream****

播流名称。

Code Integer 0

错误码。

Msg String ok

提示信息。

PageNum Integer 1

分页页码。

PageSize Integer 20

每页大小。

RequestId String 180FA0D2-1A02-5158-A36B-115DBF7B218D

请求ID。

TotalNum Integer 20

符合条件的总个数。

TotalPage Integer 20

总页数。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=DescribeLiveRecordNotifyRecords
&DomainName=example.com
&AppName=liveApp****
&StreamName=liveStream****
&PageSize=10
&PageNumber=1
&Status=success
&StartTime=2023-02-10T21:03:47Z
&EndTime=2023-02-10T21:03:47Z
&公共请求参数

正常返回示例

XML格式

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

<DescribeLiveRecordNotifyRecordsResponse>
    <CallbackList>
        <AppName>liveApp****</AppName>
        <Description>success</Description>
        <DomainName>example.com</DomainName>
        <NotifyContent>7月26日 16:14{"domain":"al.xxxx.com","stream":"livestream01","pull _stream_result":true,"cdn":"al"}</NotifyContent>
        <NotifyResult>success</NotifyResult>
        <NotifyTime>2022-10-19T19:09:28Z</NotifyTime>
        <NotifyType>record_started</NotifyType>
        <NotifyUrl>http://learn.aliyundoc.com/examplecallback.action</NotifyUrl>
        <StreamName>liveStream****</StreamName>
    </CallbackList>
    <Code>0</Code>
    <Msg>ok</Msg>
    <PageNum>1</PageNum>
    <PageSize>20</PageSize>
    <RequestId>180FA0D2-1A02-5158-A36B-115DBF7B218D</RequestId>
    <TotalNum>20</TotalNum>
    <TotalPage>20</TotalPage>
</DescribeLiveRecordNotifyRecordsResponse>

JSON格式

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

{
  "CallbackList" : [ {
    "AppName" : "liveApp****",
    "Description" : "success",
    "DomainName" : "example.com",
    "NotifyContent" : "7月26日 16:14{\"domain\":\"al.xxxx.com\",\"stream\":\"livestream01\",\"pull _stream_result\":true,\"cdn\":\"al\"}",
    "NotifyResult" : "success",
    "NotifyTime" : "2022-10-19T19:09:28Z",
    "NotifyType" : "record_started",
    "NotifyUrl" : "http://learn.aliyundoc.com/examplecallback.action",
    "StreamName" : "liveStream****"
  } ],
  "Code" : 0,
  "Msg" : "ok",
  "PageNum" : 1,
  "PageSize" : 20,
  "RequestId" : "180FA0D2-1A02-5158-A36B-115DBF7B218D",
  "TotalNum" : 20,
  "TotalPage" : 20
}

错误码

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