在输入在线媒体流后，你可以使用 StopRelayStream 停止推送在线媒体流。

使用说明
接口行为

你可以调用 StopRelayStream 接口，停止推送在线媒体流。

调用接口

关于调用接口的请求结构、公共参数、签名算法和返回结构，参看调用方法。

注意事项

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

请求说明
请求参数

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

Query
参数名称
数据类型
是否必选
示例值
描述
Action
String
是
StopRelayStream
接口名称。当前 API 的名称为 StopRelayStream。
Version
String
是
2023-11-01
接口版本。当前 API 的版本为 2023-11-01。
Body
参数
类型
是否必选
示例值
描述
AppId
String
是
Your_AppId
你的音视频应用的唯一标志
RoomId
String
是
Your_RoomId
房间的 ID，是房间的唯一标志
TaskId
String
是
Your_TaskId

任务 ID。你必须对每个任务设定 TaskId，且在进行结束任务时也须使用该 TaskId。

TaskId 是任务的标识，在一个 AppId 的 RoomId 下 taskId 是唯一的，不同 AppId 或者不同 RoomId 下 TaskId 可以重复，因此 AppId + RoomId + TaskId 是任务的唯一标识，可以用来标识指定 AppId 下某个房间内正在运行的任务，从而能在此任务运行中进行更新或者停止此任务。

关于 TaskId 及以上 Id 字段的命名规则符合正则表达式：[a-zA-Z0-9_@\-\.]{1,128}
返回参数

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

参数
类型
示例值
描述
Message
String
ok
仅在请求成功时返回"ok",失败时为空。
请求示例 
POST https://rtc.volcengineapi.com?Action=StopRelayStream&Version=2023-11-01

{
    "AppId" : "Your_AppId",
    "RoomId" : "Your_RoomId",
    "TaskId" : "Your_TaskId"
}

json
返回示例 
{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "StopRelayStream",
        "Version": " 2023-11-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "Message": "ok"
    }
}

json
错误码

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