DescribeLiveRecordNotifyRecords - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the recording callback records that are stored in Object Storage Service (OSS).

Operation description

You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
live:DescribeLiveRecordNotifyRecords	get	Domain `acs:cdn::{#accountId}:domain/{#DomainName}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The main streaming domain.	example.com
AppName	string	No	The name of the application to which the live stream belongs.	liveApp****
StreamName	string	No	The name of the live stream.	liveStream****
PageSize	long	Yes	The number of entries per page. Valid values: 1 to 500. Default value: 20.	10
PageNumber	long	Yes	The page number. Default value: 1. Valid values: 1 to 100000.	1
Status	string	No	Specifies whether the callback is successful. Valid values: success failed	success
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note You can query data within the last seven days.	2023-02-10T21:03:47Z
EndTime	string	Yes	The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2023-02-10T21:03:47Z

Response parameters

Parameter	Type	Description	Example
	object	The callback records.
CallbackList	array<object>	The callback records.
Callback	object	The callback records.
AppName	string	The name of the application to which the live stream belongs.	liveApp****
Description	string	The description of the result. A value of success indicates that the request is successful. If the request fails, an error message is returned.	success
DomainName	string	The main streaming domain.	example.com
NotifyContent	string	The callback content.	July 26, 16:14{"domain":"al.xxxx.com","stream":"livestream01","pull _stream_result":true,"cdn":"al"}
NotifyResult	string	The callback result. Valid values: success failed	success
NotifyTime	string	The time when the callback was returned. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2022-10-19T19:09:28Z
NotifyType	string	The callback type. Valid values: file_created: The recording file is created. record_error: A recording error occurs. record_started: Recording is started. record_paused: Recording is paused. record_resumed: Recording is resumed. record_force_transcode_fail: The recording task fails to trigger transcoding. transformat_error: An error occurs when the live stream is parsed.	record_started
NotifyUrl	string	The recording callback URL.	http://learn.aliyundoc.com/examplecallback.action
StreamName	string	The name of the live stream.	liveStream****
Code	integer	The error code.	0
Msg	string	The returned message.	ok
PageNum	integer	The page number.	1
PageSize	integer	The number of entries per page.	20
RequestId	string	The request ID.	180FA0D2-1A02-5158-A36B-115DBF7B218D
TotalNum	integer	The total number of entries that meet the specified conditions.	20
TotalPage	integer	The total number of pages.	20

Examples

Sample success responses

JSONformat

{
  "CallbackList": [
    {
      "AppName": "liveApp****",
      "Description": "success",
      "DomainName": "example.com",
      "NotifyContent": "July 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",
      "StreamName": "liveStream****"
    }
  ],
  "Code": 0,
  "Msg": "ok",
  "PageNum": 1,
  "PageSize": 20,
  "RequestId": "180FA0D2-1A02-5158-A36B-115DBF7B218D",
  "TotalNum": 20,
  "TotalPage": 20
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParams	Invalid JSON
400	MalformedParams	%s
400	MissingParams	%s

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-03-28	The Error code has changed	View Change Details