文档

ListRooms - 查询房间列表

更新时间:

调用ListRooms查询应用下的房间列表,包含每个房间的信息和正在使用的原子能力信息。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用加粗字体表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
imp:ListRoomsList
  • IMP
    acs:imp:*:{#accountId}:*

请求参数

名称类型必填描述示例值
AppIdstring

应用唯一标识,可以包含小写字母、数字,长度为6个字符。

7m***q
PageNumberinteger

查询页码,从1开始,参数为空默认查询第1页。

1
PageSizeinteger

每页显示个数,最大支持50,参数为空默认显示个数为10。

10

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求ID。

FE22D613-D3C6-4A58-87CA-F21FC85AA08E
Resultobject

查询房间列表的返回结果。

TotalCountinteger

房间总数。

1000
PageTotalinteger

房间列表总页数。

100
HasMoreboolean

是否还有下一页。

true
RoomInfoListarray

房间列表。

object

房间对象。

RoomIdstring

房间ID,由字母、数字、小数点(.)和短横线(-)组成,最大长度36个字符。

AE35-****-T95F
Titlestring

房间标题。

RoomTitle001
RoomOwnerIdstring

房主ID。

as****hs
Noticestring

房间公告。

RoomNotice001
UvLong

用户访问数。

100
OnlineCountLong

用户在线数。

50
PluginInstanceInfoListarray

活跃插件列表。

object

活跃插件对象。

PluginTypestring

插件类型。取值:

  • live:直播。
  • chat:聊天。
  • rtc:实时音视频通讯。
  • wb:白板。
live
PluginIdstring

插件实例ID。

H63U-****-AS7D
CreateTimeLong

插件实例创建时间戳,单位:毫秒。

1624589848000
Extensionobject

插件拓展字段。

string

拓展字段值。

test001
CreateTimestring

房间创建时间戳。

1624589848000
AppIdstring

应用唯一标识,可以包含小写字母、数字,长度为6个字符。

7m***q
TemplateIdstring

创建房间使用的模板ID。

default
Extensionobject

房间拓展字段。

string

拓展字段值。

test001

示例

请求示例

http(s)://[Endpoint]/?Action=ListRooms
&AppId=7m***q
&PageNumber=1
&PageSize=10
&公共请求参数

正常返回示例

JSON格式

{
    "RequestId": "FE22D613-D3C6-4A58-87CA-F21FC85AA08E",
    "Result": {
        "TotalCount": 1000,
        "PageTotal": 100,
        "HasMore": true,
        "RoomInfoList": {
            "RoomId": "AE35-****-T95F",
            "Title": "RoomTitle001",
            "RoomOwnerId": "as****hs",
            "Notice": "RoomNotice001",
            "Uv": 100,
            "OnlineCount": 50,
            "PluginInstanceInfoList": {
                "PluginType": "live",
                "PluginId": "H63U-****-AS7D",
                "CreateTime": 1624589848000,
                "Extension": {
                    "key": "test001"
                }
            },
            "CreateTime": 1624589848000,
            "AppId": "7m***q",
            "TemplateId": "default",
            "Extension": {
                "key": "test001"
            }
        }
    }
}

XML格式

<ListRoomsResponse>
    <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>
    <Result>
        <TotalCount>1000</TotalCount>
        <PageTotal>100</PageTotal>
        <HasMore>true</HasMore>
        <RoomInfoList>
            <RoomId>AE35-****-T95F</RoomId>
            <Title>RoomTitle001</Title>
            <RoomOwnerId>as****hs</RoomOwnerId>
            <Notice>RoomNotice001</Notice>
            <Uv>100</Uv>
            <OnlineCount>50</OnlineCount>
            <PluginInstanceInfoList>
                <PluginType>live</PluginType>
                <PluginId>H63U-****-AS7D</PluginId>
                <CreateTime>1624589848000</CreateTime>
                <Extension>
                    <key>test001</key>
                </Extension>
            </PluginInstanceInfoList>
            <CreateTime>1624589848000</CreateTime>
            <AppId>7m***q</AppId>
            <TemplateId>default</TemplateId>
            <Extension>
                <key>test001</key>
            </Extension>
        </RoomInfoList>
    </Result>
</ListRoomsResponse>

错误码

Http code错误码错误信息描述
400Forbidden.Room.InvalidPageNumberPageNumber is invalid.PageNumber非法。
400Forbidden.Room.InvalidPageSizePageSize exceeds maximum limit.PageSize过大,超出限制。

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

  • 本页导读 (1)
文档反馈