Listing Rooms
Function
Lists rooms created in a specified period.
The maximum query time span is 90 days.
URI
GET /v1/{project_id}/rtc/rooms
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
app |
Yes |
String |
Application identifier. |
room_id |
No |
String |
Room ID. |
state |
No |
String |
Room status. The options are as follows:
|
start_time |
No |
String |
Time when the query starts. UTC time in the format of YYYY-MM-DDThh:mm:ssZ, for example, 2020-04-23T06:00:00Z. If this parameter is not specified, data of the last hour is read by default. |
end_time |
No |
String |
Time when the query ends. UTC time in the format of YYYY-MM-DDThh:mm:ssZ, for example, 2020-04-23T07:00:00Z. If this parameter is not specified, the current time is used by default. |
limit |
No |
Integer |
Total number of records in the query result. |
offset |
No |
Integer |
Query offset. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token. This parameter is mandatory when token authentication is used. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Authorization |
No |
String |
Authentication information. This parameter is mandatory when AK/SK-based authentication is used. |
X-Sdk-Date |
No |
String |
Time when the request is sent. This parameter is mandatory when AK/SK-based authentication is used. |
X-Project-Id |
No |
String |
Project ID, which is the same as that used in the URI. This parameter is mandatory when AK/SK-based authentication is used. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
X-Request-Id |
String |
Unique ID of the request. |
Parameter |
Type |
Description |
---|---|---|
total |
Integer |
Total number of records. |
limit |
Integer |
Number of records in the query result. |
offset |
Integer |
Query offset. |
room_info_list |
Array of RtcServerRoomInfo objects |
Room list. |
Parameter |
Type |
Description |
---|---|---|
domain |
String |
Domain name. |
app |
String |
Application identifier. |
room_id |
String |
Room ID. |
state |
String |
Room status. The options are as follows:
|
duration |
Integer |
Room duration. |
start_time |
String |
Start time of the room, that is, the time when the first user joins the room. The value is UTC time in the format of YYYY-MM-DDThh:mm:ssZ, for example, 2020-04-23T07:00:00Z. |
end_time |
String |
End time of the room, that is, the time when the last user leaves the room. The value is UTC time in the format of YYYY-MM-DDThh:mm:ssZ, for example, 2020-04-23T07:00:00Z. If the room is not closed, a hyphen (-) is returned. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Requests
GET /v1/{project_id}/rtc/rooms?app=5fa682b34a974f7ad24d223b
Example Responses
Status code: 200
This status code is returned if the request succeeds.
{ "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 }
Status code: 400
This status code is returned if the request fails.
{ "error_code" : "DATA.100011001", "error_msg" : "Required String parameter 'app' is not present" }
Status Codes
Status Code |
Description |
---|---|
200 |
This status code is returned if the request succeeds. |
400 |
This status code is returned if the request fails. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackFor any further questions, feel free to contact us through the chatbot.
Chatbot