DescribeLiveStreamsNotifyRecords - 查询流回调记录

查询流回调记录。

接口说明

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

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

live:DescribeLiveStreamsNotifyRecords

get

*Domain

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

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 ID。

cn-shanghai

DomainName

string

推流域名。

push.example1.com

AppName

string

直播流所属应用名称。您可在流管理页面查看 AppName。

app

StreamName

string

直播流名称。您可在流管理页面查看 StreamName。

stream

Status

string

回调是否成功。

  • success:成功。

  • failed:失败。

success

StartTime

string

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

说明

开始时间必须在近 7 天内。

2017-12-10T08:00:00Z

EndTime

string

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

2017-12-10T09:00:00Z

PageSize

integer

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

20

PageNumber

integer

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

1

返回参数

名称

类型

描述

示例值

object

推流回调记录。

NotifyRecordsInfo

object

LiveStreamNotifyRecordsInfo

array<object>

推流回调记录。

object

NotifyType

string

回调类型。

  • publish:表示推流事件。

  • publish_done:表示断流事件。

publish_done

Description

string

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

success

StreamName

string

直播流名称。

stream

NotifyTime

string

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

2022-10-19T19:09:28Z

DomainName

string

推流域名。

push.example1.com

NotifyContent

string

回调的具体内容。

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

NotifyResponse

string

用户端接受回调后返回的响应结果。

{"Code":0,"Msg":"Success"}

NotifyUrl

string

回调 URL。

http://xx.xx.xx.xx/callbacks

NotifyResult

string

回调结果。

  • success:成功。

  • failed:失败。

success

AppName

string

直播流所属应用名称。

app

PageNum

integer

分页页码。

1

PageSize

integer

每页大小。

20

RequestId

string

请求 ID。

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

TotalNum

integer

符合条件的总个数。

20

TotalPage

integer

总页数。

20

示例

正常返回示例

JSON格式

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

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidStartTime.Malformed Specified parameter StartTime is not valid.
400 InvalidEndTime.Malformed Specified parameter EndTime is not valid.
400 InvalidParam Parameter invalid. 输入参数不合法
400 InvalidEndTime.Mismatch Specified EndTime does not match the specified StartTime.
400 Duration.Exceed StartTime needs to be within the last 7 days.
500 InternalError The request processing has failed due to backend service exception.

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

变更历史

更多信息,参考变更详情