DescribeRtcMPUEventSub - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

Usage notes

You can call this operation to query information about a subscription to mixed-stream relay events.
Before you call this operation, make sure that you have called the CreateRtcMPUEventSub operation to create the subscription.

QPS limit

You can call this operation up to 50 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. For more information, see QPS limits.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The ID of your application. Note The ID can be up to 64 characters in length and can contain letters, digits, underscores, and hyphens (-).	yourAppId

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	****3B-0E1A-586A-AC29-742247****
SubInfo	object	The information about the subscription.
SubId	string	The ID of the subscription.	Sub-****9799B2C4500****
AppId	string	The application ID. You can specify only one application ID.	yourAppId
ChannelIds	string	The ID of the channel to which mixed-stream relay event callbacks are sent. Multiple channel IDs are separated by commas (,). If this parameter is not returned, mixed-stream relay event callbacks are sent to all channels.	yourCh1,yourCh2
CreateTime	string	The time when the event callback was fired. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.	2024-04-09 18:00:00Z
CallbackUrl	string	The callback URL.	http://testcallback***.com/callback

Examples

Success response

JSON format

{
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "SubInfo": {
    "SubId": "Sub-******9799B2C4500******",
    "AppId": "yourAppId",
    "ChannelIds": "yourCh1,yourCh2",
    "CreateTime": "2024-04-09 18:00:00Z",
    "CallbackUrl": "http://testcallback***.com/callback"
  }
}

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.