調(diào)用ListRooms查詢應(yīng)用下的房間列表，包含每個(gè)房間的信息和正在使用的原子能力信息。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
調(diào)試授權(quán)信息
下表是API對應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別：是指每個(gè)操作的訪問級(jí)別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對于必選的資源類型，用加粗字體表示。
- 對于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| imp:ListRooms | List |
|
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| AppId | string | 是 | 應(yīng)用唯一標(biāo)識(shí)，可以包含小寫字母、數(shù)字，長度為6個(gè)字符。 | 7m***q |
| PageNumber | integer | 否 | 查詢頁碼，從1開始，參數(shù)為空默認(rèn)查詢第1頁。 | 1 |
| PageSize | integer | 否 | 每頁顯示個(gè)數(shù)，最大支持50，參數(shù)為空默認(rèn)顯示個(gè)數(shù)為10。 | 10 |
返回參數(shù)
示例
請求示例
http(s)://[Endpoint]/?Action=ListRooms
&AppId=7m***q
&PageNumber=1
&PageSize=10
&公共請求參數(shù)
正常返回示例
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>錯(cuò)誤碼
| Http code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
|---|---|---|---|
| 400 | Forbidden.Room.InvalidPageNumber | PageNumber is invalid. | PageNumber非法。 |
| 400 | Forbidden.Room.InvalidPageSize | PageSize exceeds maximum limit. | PageSize過大，超出限制。 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。