调用ListRooms查询房间列表-阿里云帮助中心

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

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
imp:ListRooms	List	IMP acs:imp::{#accountId}:	无	无

请求参数

名称	类型	必填	描述	示例值
AppId	string	是	应用唯一标识，可以包含小写字母、数字，长度为6个字符。	7m***q
PageNumber	integer	否	查询页码，从1开始，参数为空默认查询第1页。	1
PageSize	integer	否	每页显示个数，最大支持50，参数为空默认显示个数为10。	10

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求ID。	FE22D613-D3C6-4A58-87CA-F21FC85AA08E
Result	object	查询房间列表的返回结果。
TotalCount	integer	房间总数。	1000
PageTotal	integer	房间列表总页数。	100
HasMore	boolean	是否还有下一页。	true
RoomInfoList	array	房间列表。
	object	房间对象。
RoomId	string	房间ID，由字母、数字、小数点（.）和短横线（-）组成，最大长度36个字符。	AE35-****-T95F
Title	string	房间标题。	RoomTitle001
RoomOwnerId	string	房主ID。	as****hs
Notice	string	房间公告。	RoomNotice001
Uv	Long	用户访问数。	100
OnlineCount	Long	用户在线数。	50
PluginInstanceInfoList	array	活跃插件列表。
	object	活跃插件对象。
PluginType	string	插件类型。取值： live：直播。 chat：聊天。 rtc：实时音视频通讯。 wb：白板。	live
PluginId	string	插件实例ID。	H63U-****-AS7D
CreateTime	Long	插件实例创建时间戳，单位：毫秒。	1624589848000
Extension	object	插件拓展字段。
	string	拓展字段值。	test001
CreateTime	string	房间创建时间戳。	1624589848000
AppId	string	应用唯一标识，可以包含小写字母、数字，长度为6个字符。	7m***q
TemplateId	string	创建房间使用的模板ID。	default
Extension	object	房间拓展字段。
	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	错误码	错误信息	描述
400	Forbidden.Room.InvalidPageNumber	PageNumber is invalid.	PageNumber非法。
400	Forbidden.Room.InvalidPageSize	PageSize exceeds maximum limit.	PageSize过大，超出限制。

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