ListEventSub - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the events generated in channels to which you subscribe.

Operation description

QPS Limit

The QPS limit for this API per user is 50 times/second. Exceeding this limit will result in API calls being throttled, which may impact your business operations. Please use the API reasonably. For more information, please refer to QPS Limitation.

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:
- The required resource types are displayed in bold characters.
- 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:ListEventSub	list	*Rtc `acs:live::{#accountId}:rtc/{#AppId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The application ID.	9qb1****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	AE050E24-BE9B-1E79-BB30-7EA0BBAE7F08
Subscribers	array<object>	The events.
data	object	The information about the event.
SubId	string	The ID of the event.	09be0d2254cb5a89f4cbd86403ec****
ChannelId	string	The ID of the channel to which you subscribe.	testmodify
Events	array	The type of the event. Valid values: ChannelEvent: channel event. For example, the channel is opened or closed. UserEvent: user event. For example, a user joins or leaves the channel.
events	string	Subscribe to events.	ChannelEvent
CallbackUrl	string	The callback URL.	http://****.com/callback
CreateTime	string	The time when the subscription was created. The time is displayed in UTC+8. Format: yyyy-MM-dd hh:mm:ss.	2023-08-18 10:14:49
ModifyTime	string	The time when the subscription was modified. The time is displayed in UTC+8. Format: yyyy-MM-dd hh:mm:ss.	2023-08-18 10:14:49
Users	array	The user whose events are returned. We recommend that you use either this parameter or Roles.
users	string	Callback only for events of this user, not recommended to be used with Roles.	testUser
Roles`deprecated`	integer	The role of the user whose events are returned. Valid values: 1: streamer 2: viewer An empty value or a value other than 1 and 2 indicates that events of all users in the channel are returned. Note This parameter is deprecated. When you create a subscription, this parameter is no longer supported.	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "AE050E24-BE9B-1E79-BB30-7EA0BBAE7F08",
  "Subscribers": [
    {
      "SubId": "09be0d2254cb5a89f4cbd86403ec****",
      "ChannelId": "testmodify",
      "Events": [
        "ChannelEvent"
      ],
      "CallbackUrl": "http://****.com/callback",
      "CreateTime": "2023-08-18 10:14:49",
      "ModifyTime": "2023-08-18 10:14:49",
      "Users": [
        "testUser"
      ],
      "Roles": 1
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InputInvalid	%s.	Illegal input parameters
403	NoAuth	%s.	No permission
404	ResourceNotExist	%s.	The requested resource does not exist, please check and try again
500	ServerError	%s.	Unknown error, please try again later or submit a ticket for consultation.

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

Change history

Change time	Summary of changes	Operation

No change history