DescribeChannelParticipants - 查询频道内在线用户列表

查询频道内在线用户列表。

接口说明

本接口用于查询频道内在线用户列表，不包含用户详细信息。

QPS 限制

本接口的单用户 QPS 限制为 100 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
live:DescribeChannelParticipants	none	Domain `acs:live::{#accountId}:domain/{#DomainName}`	无	无

请求参数

名称	类型	必填	描述	示例值
AppId	string	是	应用 ID，仅支持传单个 ID。	aec****
ChannelId	string	是	加入的频道，仅支持传单个 ID。	testId
PageNum	integer	否	当前页码。默认值为 1。	1
PageSize	integer	否	每页显示用户数量，默认每页显示 10 条用户数据。	10
Order	string	否	排序方式，取值： asc：递增。 desc（默认值）：递减。	asc

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	6159ba01-6687-4fb2-a831-f0cd8d1******
Times	long	返回结果时间，使用 UNIX 时间戳表示，单位：秒。	1557909133
TotalNum	integer	返回结果数。	3
TotalPage	integer	返回分页数。	1
UserList	array	用户 ID 列表。
Users	string	用户 ID 列表，多个用英文逗号（,）分隔。	27f9**,bb87,df82**

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-06-13	API 内部配置变更，不影响调用	查看变更详情