使用DescribeLiveStreamsNotifyRecords查詢推流回調記錄-ApsaraVideo for Live-阿里雲 - ApsaraVideo Live

查詢流回呼記錄。

介面說明

本介面的單使用者 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 : 成功。 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\"}
NotifyUrl	string	回調 URL。	http://xx.xx.xx.xx/callbacks
NotifyResult	string	回調結果。 success：成功。 failed：失敗。	success
AppName	string	直播流所屬應用程式名稱。	app
NotifyResponse	string	使用者端接受回調後返回的響應結果。	{"Code":0,"Msg":"Success"}
NotifyHeader	string	回調請求的要求標頭。	Host: 123456.cn-shanghai.example1.com User-Agent: Go-http-client/1.1 Accept-Encoding: gzip
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\\\"}",
        "NotifyUrl": "http://xx.xx.xx.xx/callbacks",
        "NotifyResult": "success",
        "AppName": "app",
        "NotifyResponse": "{\"Code\":0,\"Msg\":\"Success\"}",
        "NotifyHeader": "Host: 123456.cn-shanghai.example1.com\nUser-Agent: Go-http-client/1.1\nAccept-Encoding: gzip"
      }
    ]
  },
  "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.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。