DescribeUserInfoInChannel_音视频通信_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

使用说明

本接口用于查询用户在频道中实时信息。例如:您可以查询用户角色类型、入会时间等信息。

QPS 限制

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
暂无数据

请求参数

字段名称字段详情
AppIdstring

应用 ID,通过控制台创建和查询,仅支持传单个 ID。

示例值:4eah****
ChannelIdstring

频道 ID,仅支持传单个 ID。

示例值:1234参考取值来源:
    DescribeRtcChannelList
UserIdstring

用户 ID,仅支持传单个 ID。

示例值:testId参考取值来源:
    RemoveUsers

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:6159ba01-6687-4fb2-a831-f0cd8d188648
Timestampinteger<int32>

当前时刻的时间戳(UTC 时间)。

示例值:1557909133
IsInChannelboolean

用户当前是否在频道内,取值:展开详情

示例值:true
IsChannelExistboolean

频道是否存在,取值:展开详情

示例值:true
Propertyarray<object>

用户在频道内的信息。

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
request.norequestid
no request诊断
400
request.noaliuid
no aliuid诊断
400
request.noappid
no appid诊断
400
request.nochannelid
no channelid诊断
400
request.nouserid
no userid诊断
400
service.signalrequesterror
signal request error诊断
401
request.illegalauth
illegal auth诊断
401
request.authinvalid
auth invalid诊断
500
service.signalrequesterror
signal send msg error诊断

变更历史

暂无变更历史

相关示例