DescribeLiveRecordNotifyRecords - 查询直播录制回调记录

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

接口说明

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

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

live:DescribeLiveRecordNotifyRecords

get

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

请求参数

名称

类型

必填

描述

示例值

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:成功。

  • failed:失败。

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

回调的具体内容。

726日 16:14{"domain":"al.xxxx.com","stream":"livestream01","pull _stream_result":true,"cdn":"al"}

NotifyResult

string

回调结果。

  • success:成功。

  • failed:失败。

success

NotifyTime

string

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

2022-10-19T19:09:28Z

NotifyType

string

回调种类。

  • file_created:录制文件创建成功。

  • record_error:录制错误。

  • record_started:录制已经成功开始。

  • record_paused:录制已经成功暂停。

  • record_resumed:录制已经成功恢复继续录制。

  • record_force_transcode_fail:录制任务触发转码失败。

  • transformat_error:直播流内容解析出错。

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

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

变更历史

更多信息,参考变更详情