查询房间列表 - ListRtcRoomList
功能介绍
指定时间范围查询这段期间创建的房间列表。
最大查询跨度90天。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/rtc/rooms
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 项目ID，获取方法请参考获取项目ID。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
app | 是 | String | 应用标识 |
room_id | 否 | String | 房间id |
state | 否 | String | 房间状态，取值如下：
|
start_time | 否 | String | 查询起始时间。UTC时间，格式：YYYY-MM-DDThh:mm:ssZ，如2020-04-23T06:00:00Z，不写默认读取过去1小时数据数据。 |
end_time | 否 | String | 查询结束时间。UTC时间，格式：YYYY-MM-DDThh:mm:ssZ，如2020-04-23T07:00:00Z，不写默认为当前时间。 |
limit | 否 | Integer | 查询结果条数 |
offset | 否 | Integer | 查询偏移量 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 否 | String | 用户Token 使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
Authorization | 否 | String | 使用AK/SK方式认证时必选，携带的鉴权信息。 |
X-Sdk-Date | 否 | String | 使用AK/SK方式认证时必选，请求的发生时间。 |
X-Project-Id | 否 | String | 使用AK/SK方式认证时必选，携带项目ID信息，与路径参数中的项目ID相同。 |
响应参数
状态码：200
参数 | 参数类型 | 描述 |
|---|---|---|
X-Request-Id | String | 请求的唯一标识 |
参数 | 参数类型 | 描述 |
|---|---|---|
total | Integer | 总数 |
limit | Integer | 查询结果限制 |
offset | Integer | 查询偏移量 |
room_info_list | Array of RtcServerRoomInfo objects | 房间列表信息 |
参数 | 参数类型 | 描述 |
|---|---|---|
domain | String | 域名 |
app | String | 应用标识 |
room_id | String | 房间ID |
state | String | 房间状态，取值如下：
|
duration | Integer | 房间持续时长，单位：秒 |
start_time | String | 房间开始时间，即第一个用户加入房间时间，UTC时间，格式：YYYY-MM-DDThh:mm:ssZ，如2020-04-23T07:00:00Z |
end_time | String | 房间关闭时间，即最后一个room_uuid关闭的时间，UTC时间，格式：YYYY-MM-DDThh:mm:ssZ，如2020-04-23T07:00:00Z，若房间未关闭，则返回 “-” |
状态码：400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 |
error_msg | String | 错误描述。 |
请求示例
GET /v1/{project_id}/rtc/rooms?app=5fa682b34a974f7ad24d223b 响应示例
状态码：200
查询成功返回。
{
"total" : 1,
"room_info_list" : [ {
"domain" : "603f71bdfa163e500aff1106c8xxxxxx.sparkrtc.myhuaweicloud.com",
"app" : "603f71bdfa163e500aff1106c8xxxxxx",
"room_id" : "ac146d0f2779916191716070xxxxxx",
"state" : "RUNNING",
"start_time" : "2021-04-23T09:55:30Z",
"end_time" : "-"
} ],
"offset" : 0,
"limit" : 2
} 状态码：400
查询失败返回
{
"error_code" : "DATA.100011001",
"error_msg" : "Required String parameter 'app' is not present"
} 状态码
状态码 | 描述 |
|---|---|
200 | 查询成功返回。 |
400 | 查询失败返回 |
错误码
请参见错误码。
