調用DescribeLiveRecordNotifyRecords查詢直播錄製至OSS的回調記錄-ApsaraVideo for Live-阿里雲 - ApsaraVideo Live

查詢直播錄製儲存至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
StorageType	string	否	查詢對應錄製儲存方式的回呼記錄。 oss: 錄製到 oss vod: 錄製到 vod all: 不區分儲存類型，查詢所有儲存方式的回呼記錄	oss

返回參數

名稱	類型	描述	樣本值
	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：成功。 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
NotifyHeader	string	回呼請求 header。	{ "Content-Type": [ "application/json; charset=utf-8" ] }
StreamName	string	播流名稱。	liveStream****
NotifyResponse	string	使用者端接受回呼後返回的回應結果。	{"Code":0,"Msg":"Success"}
StorageType	string	錄製儲存方式。取值： oss：錄製到 oss vod：錄製到 vod all: 所有儲存方式	oss
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",
      "NotifyHeader": "{\n  \"Content-Type\": [\n    \"application/json; charset=utf-8\"\n  ]\n}",
      "StreamName": "liveStream****",
      "NotifyResponse": "{\"Code\":0,\"Msg\":\"Success\"}",
      "StorageType": "oss"
    }
  ],
  "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	MissingParams	%s, please check and try again later.
400	MalformedParams	%s, please check and try again later.

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

變更歷史

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