DescribeChannelParticipants - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries online users in a channel.

Operation description

You can call this operation to query online users in a channel. The returned result does not include details about the users.

QPS limit

You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you take note of this limit when you call this operation.

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:DescribeChannelParticipants	none	Domain `acs:live::{#accountId}:domain/{#DomainName}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The ID of the application. You can specify only one application ID.	aec****
ChannelId	string	Yes	The ID of the channel. You can specify only one channel ID.	testId
PageNum	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 10.	10
Order	string	No	The sort order. Valid values: asc: ascending order. desc: descending order. This is the default value.	asc

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	6159ba01-6687-4fb2-a831-f0cd8d188648
Times	long	The time elapsed until the result was returned. Unit: seconds. The value is a UNIX timestamp.	1557909133
TotalNum	integer	The number of entries returned.	3
TotalPage	integer	The page number of the returned page.	1
UserList	array	The list of user IDs.
Users	string	The IDs of the users in the channel. Multiple user IDs are separated by commas (,).	27f9**,bb87,df82**

Examples

Sample success responses

JSONformat

{
  "RequestId": "6159ba01-6687-4fb2-a831-f0cd8d188648",
  "Times": 1557909133,
  "TotalNum": 3,
  "TotalPage": 1,
  "UserList": [
    "27f9****,bb87****,df82****"
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-06-13	The internal configuration of the API is changed, but the call is not affected	View Change Details