ListRtcMPUEventSubRecord - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the callback records of a subscription to mixed-stream relay events.

Operation description

You can call this operation to query the callback records of a subscription to mixed-stream relay events in the last seven days.

QPS limit

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.

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 application. Note The ID can be up to 64 characters in length and can contain letters, digits, underscores (_), and hyphens (-).	yourAppId
SubId	string	No	The ID of the subscription.	yourSubId
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.	1970-01-01T00:00:00Z
EndTime	string	Yes	The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.	1970-01-01T00:00:00Z
PageSize	integer	Yes	The number of entries 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 ID of the request.	****3B-0E1A-586A-AC29-742247****
Count	integer	The number of entries per page.	1
HasMore	boolean	Indicates whether the current page is followed by a page.	false
Logs	array<object>	The callback records.
	object	The callback record.
AppId	string	The ID of the application.	yourAppId
SubId	string	The ID of the subscription.	Sub-****9799B2C4500****
MsgId	string	The ID of the callback record.	42bba8b5-********-9b501dd6cb6e
Data	string	For more information about the callback, see CreateRtcMPUEventSub.	{\"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. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in 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 HTTP status code. 200 indicates that the callback is 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.