調用GetRoom查詢指定房間信息,包含房間信息和使用中的原子能力信息。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
調試
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用加粗字體表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
imp:GetRoom | Read |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppId | string | 是 | 應用唯一標識,可以包含小寫字母、數字,長度為6個字符。 | 7m***q |
RoomId | string | 是 | 房間ID,由字母、數字、小數點(.)和短橫線(-)組成,最大長度36個字符。 | AE35-****-T95F |
返回參數
示例
請求示例
http(s)://[Endpoint]/?Action=GetRoom
&AppId=7m***q
&RoomId=AE35-****-T95F
&公共請求參數
正常返回示例
JSON
格式
{
"RequestId": "FE22D613-D3C6-4A58-87CA-F21FC85AA08E",
"Result": {
"RoomInfo": {
"RoomId": "AE35-****-T95F",
"Title": "RoomTitle001",
"CreateTime": 1624589848000,
"Notice": "RoomNotice001",
"RoomOwnerId": "as****hs",
"Uv": 100,
"OnlineCount": 50,
"PluginInstanceInfoList": [
{
"PluginType": "live",
"PluginId": "HASU-****-ASHD",
"CreateTime": 1624589848000,
"Extension": {
"key": "test001"
}
}
],
"AppId": "lq****cu",
"TemplateId": "default",
"Extension": {
"key": "test001"
},
"Pv": 200,
"AdminIdList": [
"as****hs"
]
}
}
}
XML
格式
<GetRoomResponse>
<RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>
<Result>
<RoomInfo>
<RoomId>AE35-****-T95F</RoomId>
<Title>RoomTitle001</Title>
<CreateTime>1624589848000</CreateTime>
<Notice>RoomNotice001</Notice>
<RoomOwnerId>as****hs</RoomOwnerId>
<Uv>100</Uv>
<OnlineCount>50</OnlineCount>
<PluginInstanceInfoList>
<PluginType>live</PluginType>
<PluginId>HASU-****-ASHD</PluginId>
<CreateTime>1624589848000</CreateTime>
<Extension>
<key>test001</key>
</Extension>
</PluginInstanceInfoList>
<AppId>lq****cu</AppId>
<TemplateId>default</TemplateId>
<Extension>
<key>test001</key>
</Extension>
<Pv>200</Pv>
<AdminIdList>as****hs</AdminIdList>
</RoomInfo>
</Result>
</GetRoomResponse>
錯誤碼
Http code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidRoomId.Room.NotExist | Room does not exist. | 房間不存在,請檢查。 |
訪問錯誤中心查看更多錯誤碼。