如果你已经输入了在线媒体流，你可以查询指定 AppId 下指定房间内所有输入的媒体流任务。你可以使用 ListRelayStream 这个 OpenAPI 实现这一功能。

使用说明

接口行为

你可以调用 ListRelayStream 接口，指定 AppId 和 RoomId查询该房间内输入的所有的媒体流任务。

单次查询最多可以查到 10000 条输入媒体流任务。

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制，参看调用OpenAPI。

注意事项

请求频率：QPS 不得超过 150。

请求说明

请求方式：GET
请求地址：https://rtc.volcengineapi.com?Action=ListRelayStream&Version=2023-11-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListRelayStream`	接口名称。当前 API 的名称为 `ListRelayStream`。
Version	String	是	`2023-11-01`	接口版本。当前 API 的版本为 `2023-11-01`。
AppId	String	是	`Your_AppId`	应用的唯一标志。
RoomId	String	是	`Your_RoomId`	要查询房间的 ID
Offset	Integer	否	`0`	起始位置，默认值为 `0`。
Limit	Integer	否	`10`	页大小，取值范围为`[1,100]`，默认值为 `10`
Order	Integer	否	`0`	接口调用时间顺序。 `0`：倒序。 `1`：正序。默认值为`0`

返回参数

下表仅列出本接口特有的返回参数，公共返回参数请参见返回结构。

参数	类型	示例值	描述
Task	Array of Task	`-`	任务列表
Total	Integer	`1`	当前页大小
Offset	Integer	`0`	下一页索引
Limit	Integer	`10`	页大小

Task

参数	类型	示例值	描述
AppId	String	`Your_AppId`	应用的唯一标志
RoomId	String	`Your_RoomId`	房间 ID，是房间的唯一标志
UserId	String	`Your_UserId`	在线媒体流对应的 UserId
TaskId	String	`Your_TaskId`	任务 ID
Status	Integer	`1`	任务当前状态。 `1`：任务启动中。 `2`：任务运行中。 `3`：任务已结束
CreateTime	Integer	`1656332552`	任务开始时间，Unix 时间戳，单位为秒
StreamUrl	String	`rtmp://xxx`	在线媒体流地址
StreamMode	Integer	`0`	流处理模式。 `0`：转码 `1`：转封装
MediaType	Integer	`0`	媒体类型。 `0`：音视频 `1`：音频 `2`：视频
VideoWidth	Integer	`640`	视频宽度。单位为 px，范围为 `[16, 1920]`。
VideoHeight	Integer	`480`	视频高度，单位为 px，范围为 `[16, 1920]`。
FrameRate	Integer	`15`	发送帧率，值的范围为`[1，60]`，默认值为`15`，转码时生效。

请求示例

GET https://rtc.volcengineapi.com?Action=ListRelayStream&Version=2023-11-01&AppId=Your_AppId&RoomId=Your_RoomId&Offset=0&Limit=10&Order=0
json

返回示例

{
    "Result": {
        "Task": [
            {
                "AppId": "Your_AppId",
                "RoomId": "Your_RoomId",
                "TaskId": "Your_TaskId",
                "StreamUrl": "rtmp://xxx",
                "MediaType": 0,
                "StreamMode": 0,
                "VideoWidth": 1920,
                "VideoHeight": 1080,
                "FrameRate": 30,
                "Bitrate": 6000,
                "Loop": true,
                "UserId": "Your_UserId",
                "Status": 2,
                "CreateTime": 1656332552
            }
        ],
        "Offset": 0,
        "Limit": 10,
        "Total": 1
    },
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "ListRelayStream",
        "Version": "2023-11-01"
    }
}
json

错误码

您可访问公共错误码，获取更多错误码信息。