Retrieve Mixed-Stream Relay Callback Records to Monitor Events - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Queries the event subscription records for stream mixing and forwarding.

Operation description

Queries the event subscription records for stream mixing and forwarding. You can query data from the last seven days.

QPS limit

The single-user QPS limit for this operation is 100 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation as needed.

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:ListRtcMPUEventSubRecord

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The ID of the subscribed application. You can view your application IDs by navigating to ApsaraVideo Live > Live+ > ApsaraVideo Real-time Communication > Application Management. Note The application ID consists of uppercase and lowercase letters, digits, underscores, and hyphens (-), with a maximum of 64 characters. You must first call CreateRtcMPUEventSub to create a stream mixing and forwarding event subscription for this application ID.	yourAppId
SubId	string	No	The callback ID of the subscription.	yourSubId
StartTime	string	Yes	The start time of the query. Format: yyyy-MM-ddTHH:mm:ssZ (UTC). The value cannot be earlier than seven days before the current time.	1970-01-01T00:00:00Z
EndTime	string	Yes	The end time of the query. Format: yyyy-MM-ddTHH:mm:ssZ (UTC). The value cannot be later than the current time.	1970-01-01T00:00:00Z
PageSize	integer	Yes	The number of records per page. Valid values: 1 to 100.	10
PageNo	integer	Yes	The page number.	20

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	****3B-0E1A-586A-AC29-742247****
Count	integer	The total number of callback records returned on the current page.	1
HasMore	boolean	Indicates whether there is a next page.	false
Logs	array<object>	The callback records.
	object	The callback records.
AppId	string	The ID of the subscribed application.	yourAppId
SubId	string	The event callback ID.	Sub-****9799B2C4500****
MsgId	string	The callback record ID.	42bba8b5-********-9b501dd6cb6e
Data	string	The callback content. For more information, see Create a stream mixing and forwarding event callback.	{\"EventType\":1,\"MsgId\":\"42bba8b5-94ab-468c-9dae-9b501dd6c*\",\"AppId\":\"rtcdev\",\"SubId\":\"Sub-9799B2C45009799B2C4\",\"TaskId\":\"mpucallbacktest\",\"CallbackTs\":1712656430,\"Payload\":{\"DstUrl\":\"rtmp://domain/app/stream?auth\",\"EventTs\":1712656430*,\"EventCode\":1,\"ErrorCode\":0,\"ErrorMessage\":\"\"}}
Time	string	The time when the callback was invoked. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	1970-01-01T00:00:00Z
Cost	integer	The callback duration. Unit: milliseconds.	22
CallbackUrl	string	The callback URL.	http://testcallback***.com/callback
HTTPCode	string	The error code. A value of 200 indicates that the callback was successful.	200

Examples

Success response

JSON format

{
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "Count": 1,
  "HasMore": false,
  "Logs": [
    {
      "AppId": "yourAppId",
      "SubId": "Sub-******9799B2C4500******",
      "MsgId": "42bba8b5-********-9b501dd6cb6e",
      "Data": "{\\\"EventType\\\":1,\\\"MsgId\\\":\\\"42bba8b5-94ab-468c-9dae-9b501dd6c***\\\",\\\"AppId\\\":\\\"rtcdev\\\",\\\"SubId\\\":\\\"Sub-9799B2C45009799B2C4***\\\",\\\"TaskId\\\":\\\"mpucallbacktest\\\",\\\"CallbackTs\\\":1712656430***,\\\"Payload\\\":{\\\"DstUrl\\\":\\\"rtmp://domain/app/stream?auth\\\",\\\"EventTs\\\":1712656430***,\\\"EventCode\\\":1,\\\"ErrorCode\\\":0,\\\"ErrorMessage\\\":\\\"\\\"}}",
      "Time": "1970-01-01T00:00:00Z",
      "Cost": 22,
      "CallbackUrl": "http://testcallback***.com/callback",
      "HTTPCode": "200"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParam	%s.	Parameter verification failed
400	InvalidAppId	%s, please check and try again later.	AppId is invalid, please check and try again.
400	MissingParam	%s, please check and try again later.	Parameter is missing, please check and try again.
500	InternalError	InternalError
403	OperationDenied	Your account has not enabled the Live service
403	Forbidden	%s, please check and try again later.	No permission, please check and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.