创建relay任务

2026年 5月 20日下午3:36

**简要描述：**

- 请求NMS创建Relay中继任务。可实现拉取一路KMP/RTSP/RTMP/HTTP/FILE作为输入，KMP/RTMP/HTTP作为输出流。

**请求URL：** 
- ` http://serverip:8000/api/relay `
 
**请求方式：**
- POST

**以自定义取流方式 Body参数：**

|参数名|必选|类型|说明|
|:---- |:---|----- |----- |
|mode |是 |int |重连模式 0-永久自动重连 1-心跳保持型(用创建后的id查询流状态保活) 2-输入输出没有错误时自动重连 3-输入流结束后停止 |
|in_url |是 |string | 自定义取流地址 |
|out_url |是 |string | 自定义推流地址 |
|http_referer|否|string|拉流设置http referer来通过对方服务器验证|
|http_ua|否|string|拉流设置http ua来通过对方服务器验证|
|enhanced_rtmp|否|bool|设置rtmp推流是否按enhanced_rtmp标准来推流|
|stream_loop|否|bool|是否设置文件转推流循环推流|
|disable_audio |否 |bool | 是否关闭音频 |
|comment |否 |string | 备注 |
 
**参数示例**
```
{
	"mode":0,
	"in_url":"/var/data/demo.mp4",
	"out_url":"rtmp://127.0.0.1/live/demo",
	"disable_audio":false
}
```

```
{
	"mode":0,
	"in_url":"rtsp://admin:admin12345@192.168.0.112/Streaming/channels/101",
	"out_url":"rtmp://127.0.0.1/live/112_101",
	"disable_audio":true
}
```

```
{
	"mode":0,
	"in_url":"rtmp://192.168.0.2/live/s",
	"out_url":"kmp://192.168.0.3/live/s"
}
```

**返回示例**
```
{
 "code": 200,
 "error": "",
 "data": {
 "id": "aa8af81fc811ecf9da5d5762f4b03b53",
 "stream": ""
 }
}
```

**以预定义NVR取流方式 Body参数：**

|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|mode |是 |int |重连模式 0-永久自动重连，1-心跳保持型，2-在创建输入输出连接没有错误的时候才自动重连，3-输入流结束后停止 |
|type |否 |string | NVR取流类型 - "live" or "vod" |
|username |否 |string | NVR用户名 |
|password |否 |string | NVR密码 |
|vendor |否 |string | NVR厂商码 - "hik" "dah" "uni" |
|channel |否 |int | NVR通道号 |
|in_host |否 |string | NVR IP |
|in_port |否 |int | NVR 端口 |
|sub_stream |否 |boolean | NVR是否取子码流 |
|start_time |否 |string | NVR 取录像的开始时间 |
|end_time |否 |string | NVR 取录像的结束时间 |
|comment |否 |string | 备注 |

**请求示例**
```
{
	"mode":0,
	"type":"live",
	"username":"admin",
	"password":"admin888",
	"vendor":"hik",
	"channel":1,
	"in_host":"192.168.0.112",
	"in_port":554,
	"sub_stream":false
}
```

**返回示例**

``` 
{
 "code": 200,
 "error": "",
 "data": {
 "id": "470b5df2a9e413bb7d65921e37b36a73",
 "stream": "/live/01_192168000112_102"
 }
}
```

**返回参数说明**

|参数名|类型|说明|
|:----- |:-----|----- |
|id |string |relay任务id ，用于后续查询状态和删除任务|
|stream |string |以预置NVR参数请求时，流会拉取并自动推送到本服务器，stream是流名称|

**备注**

- 当使用预置NVR拉流时，若设置了 out_url，则不创建本地流，直接推送到该地址。
- 当以mode 1创建任务时，需要以一定频率（30s）调用查询relay状态保持心跳，超时不调用，任务自动停止。

文档

创建relay任务