DescribeLiveRecordNotifyRecords - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the callback records for live recordings stored in OSS.

Operation description

This operation supports up to 100 queries per second (QPS) per user. If you exceed this limit, your API calls are throttled. This may affect your business. Call this operation at a reasonable rate.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:DescribeLiveRecordNotifyRecords

get

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	Yes	The streaming domain.	example.com
AppName	string	No	The name of the application to which the stream belongs.	liveApp****
StreamName	string	No	The name of the stream.	liveStream****
PageSize	integer	Yes	The number of entries to return on each page. Default value: 20. Maximum value: 500. Valid values: an integer from 1 to 500.	10
PageNumber	integer	Yes	The page number. Default value: 1. Valid values: 1 to 100000.	1
Status	string	No	Indicates whether the callback was successful. success: The callback was successful. failed: The callback failed.	success
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the `yyyy-MM-ddTHH:mm:ssZ` format. The time must be in UTC. Note You can query data from the last 7 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 `yyyy-MM-ddTHH:mm:ssZ` format. The time must be in UTC.	2023-02-10T21:03:47Z

Response elements

Element	Type	Description	Example
	object	The callback records.
CallbackList	array<object>	The callback records.
	object	A callback record.
AppName	string	The name of the application to which the stream belongs.	liveApp****
Description	string	The description of the result. A value of `success` indicates that the operation was successful. Otherwise, an error message is returned.	success
DomainName	string	The streaming domain.	example.com
NotifyContent	string	The content of the callback.	7月26日 16:14{"domain":"al.xxxx.com","stream":"livestream01","pull _stream_result":true,"cdn":"al"}
NotifyResult	string	The result of the callback. success: The callback was successful. failed: The callback failed.	success
NotifyTime	string	The time when the callback was sent. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.	2022-10-19T19:09:28Z
NotifyType	string	The type of callback. file_created: The recording file was created. record_error: A recording error occurred. record_started: The recording started. record_paused: The recording was paused. record_resumed: The recording was resumed. record_force_transcode_fail: The recording task failed to trigger transcoding. transformat_error: An error occurred when parsing the live stream.	record_started
NotifyUrl	string	The webhook address for recording callbacks.	http://learn.aliyundoc.com/examplecallback.action
NotifyHeader	string
StreamName	string	The name of the stream.	liveStream****
NotifyResponse	string	The response returned by your client after your client receives the callback.	{"Code":0,"Msg":"Success"}
Code	integer	The response code.	0
Msg	string	The message returned.	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 filter criteria.	20
TotalPage	integer	The total number of pages returned.	20

Examples

Success response

JSON format

{
  "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": "",
      "StreamName": "liveStream****",
      "NotifyResponse": "{\"Code\":0,\"Msg\":\"Success\"}"
    }
  ],
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.