調用ListLiveRooms分頁查詢直播信息。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
調試
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用加粗字體表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
imp:ListLiveRooms | List |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppId | string | 是 | 用戶的應用ID,在控制臺創建應用時生成。包含小寫字母、數字,長度為6個字符。 | 7m***q |
Status | integer | 否 | 直播狀態。取值:
| 3 |
PageNumber | integer | 否 | 查詢頁碼,從1開始,參數為空默認查詢第1頁。 | 1 |
PageSize | integer | 否 | 每頁顯示個數,最大支持50,參數為空默認顯示個數為10。 | 10 |
返回參數
示例
請求示例
http(s)://[Endpoint]/?Action=ListLiveRooms
&AppId=7m***q
&Status=3
&PageNumber=1
&PageSize=10
&公共請求參數
正常返回示例
JSON
格式
{
"RequestId": "FE22D613-D3C6-4A58-87CA-F21FC85AA08E",
"Result": {
"TotalCount": 100,
"PageTotal": 10,
"HasMore": true,
"LiveList": [
{
"AppId": "7m***q",
"LiveId": "b7f2****ebb3",
"Status": 1,
"RoomId": "AE35-****-T95F",
"ChatId": "09***f8",
"Title": "Title001",
"Notice": "Notice001",
"CoverUrl": "http://***.png",
"AnchorId": "as****hs",
"Uv": 100,
"Extension": {
"key": "test001"
},
"AnchorNick": "User001",
"Pv": 200,
"OnlineCount": 50
}
]
}
}
XML
格式
<ListLiveRoomsResponse>
<RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>
<Result>
<TotalCount>100</TotalCount>
<PageTotal>10</PageTotal>
<HasMore>true</HasMore>
<LiveList>
<AppId>7m***q</AppId>
<LiveId>b7f2****ebb3</LiveId>
<Status>1</Status>
<RoomId>AE35-****-T95F</RoomId>
<ChatId>09***f8</ChatId>
<Title>Title001</Title>
<Notice>Notice001</Notice>
<CoverUrl>http://***.png</CoverUrl>
<AnchorId>as****hs</AnchorId>
<Uv>100</Uv>
<Extension>
<key>test001</key>
</Extension>
<AnchorNick>User001</AnchorNick>
<Pv>200</Pv>
<OnlineCount>50</OnlineCount>
</LiveList>
</Result>
</ListLiveRoomsResponse>
錯誤碼
訪問錯誤中心查看更多錯誤碼。