查询直播录制存储至OSS的回调记录。
接口说明
本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
live:DescribeLiveRecordNotifyRecords |
get |
*Domain
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
RegionId |
string |
否 |
地域 ID。 |
cn-shanghai |
DomainName |
string |
是 |
主播流域名。 |
example.com |
AppName |
string |
否 |
播流所属应用名称。 |
liveApp**** |
StreamName |
string |
否 |
播流名称。 |
liveStream**** |
PageSize |
integer |
是 |
每页大小。默认 20,最大 500,取值:1~500 之前的任意整数。 |
10 |
PageNumber |
integer |
是 |
当前页码。默认值为 1。取值范围为:1~100000。 |
1 |
Status |
string |
否 |
回调是否成功。
|
success |
StartTime |
string |
是 |
起始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 说明
支持查询最近 7 天内的数据。 |
2023-02-10T21:03:47Z |
EndTime |
string |
是 |
结束时间。结束时间需晚于起始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 |
2023-02-10T21:03:47Z |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
回调记录。 |
||
CallbackList |
array<object> |
回调记录。 |
|
object |
回调记录。 |
||
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 |
NotifyTime |
string |
回调时间,格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 |
2022-10-19T19:09:28Z |
NotifyType |
string |
回调种类。
|
record_started |
NotifyUrl |
string |
录制回调地址。 |
http://learn.aliyundoc.com/examplecallback.action |
NotifyResponse |
string |
用户端接受回调后返回的响应结果。 |
{"Code":0,"Msg":"Success"} |
StreamName |
string |
播流名称。 |
liveStream**** |
Code |
integer |
错误码。 |
0 |
Msg |
string |
提示信息。 |
ok |
PageNum |
integer |
分页页码。 |
1 |
PageSize |
integer |
每页大小。 |
20 |
RequestId |
string |
请求 ID。 |
180FA0D2-1A02-5158-A36B-115DBF7B218D |
TotalNum |
integer |
符合条件的总个数。 |
20 |
TotalPage |
integer |
总页数。 |
20 |
示例
正常返回示例
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",
"NotifyResponse": "{\"Code\":0,\"Msg\":\"Success\"}",
"StreamName": "liveStream****"
}
],
"Code": 0,
"Msg": "ok",
"PageNum": 1,
"PageSize": 20,
"RequestId": "180FA0D2-1A02-5158-A36B-115DBF7B218D",
"TotalNum": 20,
"TotalPage": 20
}
错误码
HTTP status code |
错误码 |
错误信息 |
描述 |
---|---|---|---|
400 | InvalidParams | Invalid JSON | |
400 | MalformedParams | %s | |
400 | MissingParams | %s |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。