Mirror/ZLMediaKit
1
0
Fork 0
mirror of https://github.com/ZLMediaKit/ZLMediaKit.git synced 2026-07-06 19:58:10 +08:00
Code Issues Packages Projects Releases Wiki Activity

locahost也需要secret

夏楚
2023-08-24 17:08:07 +08:00
parent c6d0addb22
commit 9bf6161f74
1 changed files with 32 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
MediaServer支持的HTTP-API.md

@@ -230,7 +230,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 |
| :----: | :------: | :----------------------------------------------------------: |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 |
| secret | Y | api操作密钥(配置文件配置) |
- 响应：
@@ -316,7 +316,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 |
| :----: | :------: | :----------------------------------------------------------: |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 |
| secret | Y | api操作密钥(配置文件配置) |
- 响应：
@@ -339,7 +339,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 |
| :----: | :------: | :----------------------------------------------------------: |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 |
| secret | Y | api操作密钥(配置文件配置) |
- 响应：
@@ -363,7 +363,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 |
| :----: | :------: | :----------------------------------------------------------: |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 |
| secret | Y | api操作密钥(配置文件配置) |
| schema | N | 筛选协议，例如 rtsp或rtmp |
| vhost | N | 筛选虚拟主机，例如`__defaultVhost__` |
| app | N | 筛选应用名，例如 live |
@@ -437,7 +437,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 |
| :----: | :------: | :----------------------------------------------------------: |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 |
| secret | Y | api操作密钥(配置文件配置) |
| schema | Y | 协议，例如 rtsp或rtmp |
| vhost | Y | 虚拟主机，例如`__defaultVhost__` |
| app | Y | 应用名，例如 live |
@@ -464,7 +464,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 |
| :----: | :------: | :----------------------------------------------------------: |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 |
| secret | Y | api操作密钥(配置文件配置) |
| schema | N | 协议，例如 rtsp或rtmp |
| vhost | N | 虚拟主机，例如`__defaultVhost__` |
| app | N | 应用名，例如 live |
@@ -491,7 +491,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 |
| :--------: | :------: | :----------------------------------------------------------: |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 |
| secret | Y | api操作密钥(配置文件配置) |
| local_port | N | 筛选本机端口，例如筛选rtsp链接：554 |
| peer_ip | N | 筛选客户端ip |
@@ -541,7 +541,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 |
| :----: | :------: | :----------------------------------------------------------: |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 |
| secret | Y | api操作密钥(配置文件配置) |
| Id | Y | 客户端唯一id，可以通过getAllSession接口获取 |
- 响应：
@@ -565,7 +565,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 |
| :--------: | :------: | :----------------------------------------------------------: |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 |
| secret | Y | api操作密钥(配置文件配置) |
| local_port | N | 筛选本机端口，例如筛选rtsp链接：554 |
| peer_ip | N | 筛选客户端ip |
@@ -591,7 +591,7 @@ typedef enum {
| 参数 | 参数类型 | 释意 | 是否必选 |
| :--------------: | :------: | :----------------------------------------------------------: | :------: |
| secret | `string` | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 | Y |
| secret | `string` | api操作密钥(配置文件配置) | Y |
| vhost | `string` | 添加的流的虚拟主机，例如`__defaultVhost__` | Y |
| app | `string` | 添加的流的应用名，例如live | Y |
| stream | `string` | 添加的流的id名，例如test | Y |
@@ -643,7 +643,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 |
| :----: | :------: | :----------------------------------------------------------: |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 |
| secret | Y | api操作密钥(配置文件配置) |
| key | Y | addStreamProxy接口返回的key |
- 响应：
@@ -670,7 +670,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 |
| :--------: | :------: | :----------------------------------------------------------: |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 |
| secret | Y | api操作密钥(配置文件配置) |
| src_url | Y | FFmpeg拉流地址,支持任意协议或格式(只要FFmpeg支持即可) |
| dst_url | Y | FFmpeg rtmp推流地址，一般都是推给自己，例如rtmp://127.0.0.1/live/stream_form_ffmpeg |
| timeout_ms | Y | FFmpeg推流成功超时时间 |
@@ -701,7 +701,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 |
| :----: | :------: | :----------------------------------------------------------: |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 |
| secret | Y | api操作密钥(配置文件配置) |
| key | Y | addFFmpegSource接口返回的key |
@@ -728,7 +728,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 |
| :----: | :------: | :----------------------------------------------------------: |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 |
| secret | Y | api操作密钥(配置文件配置) |
| schema | Y | 协议，例如 rtsp或rtmp |
| vhost | Y | 虚拟主机，例如`__defaultVhost__` |
| app | Y | 应用名，例如 live |
@@ -756,7 +756,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 |
| :----: | :------: | :----------------------------------------------------------: |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 |
| secret | Y | api操作密钥(配置文件配置) |
| schema | Y | 协议，例如 rtsp或rtmp |
| vhost | Y | 虚拟主机，例如`__defaultVhost__` |
| app | Y | 应用名，例如 live |
@@ -804,7 +804,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 |
| :-------: | :------: | :----------------------------------------------------------: |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 |
| secret | Y | api操作密钥(配置文件配置) |
| stream_id | Y | RTP的ssrc，16进制字符串或者是流的id(openRtpServer接口指定) |
@@ -833,7 +833,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 |
| :----: | :------: | :----------------------------------------------------------: |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 |
| secret | Y | api操作密钥(配置文件配置) |
| vhost | Y | 流的虚拟主机名 |
| app | Y | 流的应用名 |
| stream | Y | 流的ID |
@@ -884,7 +884,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 | 类型 |
| :-------------: | :------: | :----------------------------------------------------------: | ------ |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 | string |
| secret | Y | api操作密钥(配置文件配置) | string |
| type | Y | 0为hls，1为mp4 | 0/1 |
| vhost | Y | 虚拟主机，例如`__defaultVhost__` | string |
| app | Y | 应用名，例如 live | string |
@@ -915,7 +915,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 |
| :----: | :------: | :----------------------------------------------------------: |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 |
| secret | Y | api操作密钥(配置文件配置) |
| type | Y | 0为hls，1为mp4 |
| vhost | Y | 虚拟主机，例如`__defaultVhost__` |
| app | Y | 应用名，例如 live |
@@ -943,7 +943,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 |
| :----: | :------: | :----------------------------------------------------------: |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 |
| secret | Y | api操作密钥(配置文件配置) |
| type | Y | 0为hls，1为mp4 |
| vhost | Y | 虚拟主机，例如`__defaultVhost__` |
| app | Y | 应用名，例如 live |
@@ -970,7 +970,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 |
| :---------: | :------: | :----------------------------------------------------------: |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 |
| secret | Y | api操作密钥(配置文件配置) |
| url | Y | 需要截图的url，可以是本机的，也可以是远程主机的 |
| timeout_sec | Y | 截图失败超时时间，防止FFmpeg一直等待截图 |
| expire_sec | Y | 截图的过期时间，该时间内产生的截图都会作为缓存返回 |
@@ -994,7 +994,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 |
| :--------: | :------: | :----------------------------------------------------------: |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 |
| secret | Y | api操作密钥(配置文件配置) |
| port | Y | 接收端口，0则为随机端口 |
| tcp_mode | Y | 0 udp 模式，1 tcp 被动模式, 2 tcp 主动模式。 (兼容enable_tcp 为0/1) |
| stream_id | Y | 该端口绑定的流ID，该端口只能创建这一个流(而不是根据ssrc创建多个) |
@@ -1021,7 +1021,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 |
| :-------: | :------: | :----------------------------------------------------------: |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 |
| secret | Y | api操作密钥(配置文件配置) |
| stream_id | Y | 调用openRtpServer接口时提供的流ID |
@@ -1044,7 +1044,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 |
| :----: | :------: | :----------------------------------------------------------: |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 |
| secret | Y | api操作密钥(配置文件配置) |
- 响应：
@@ -1071,7 +1071,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 |
| :----: | :------: | :----------------------------------------------------------: |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 |
| secret | Y | api操作密钥(配置文件配置) |
| vhost | Y | 虚拟主机，例如__defaultVhost__ |
| app | Y | 应用名，例如 live |
| stream | Y | 流id，例如 test |
@@ -1105,7 +1105,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 |
| :----: | :------: | :----------------------------------------------------------: |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 |
| secret | Y | api操作密钥(配置文件配置) |
| vhost | Y | 虚拟主机，例如__defaultVhost__ |
| app | Y | 应用名，例如 live |
| stream | Y | 流id，例如 test |
@@ -1137,7 +1137,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 |
| :----: | :------: | :----------------------------------------------------------: |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 |
| secret | Y | api操作密钥(配置文件配置) |
| vhost | Y | 虚拟主机，例如__defaultVhost__ |
| app | Y | 应用名，例如 live |
| stream | Y | 流id，例如 test |
@@ -1162,7 +1162,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 |
| :----: | :------: | :----------------------------------------------------------: |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 |
| secret | Y | api操作密钥(配置文件配置) |
- 响应：
@@ -1197,7 +1197,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 |
| :---------: | :------: | :----------------------------------------------------------: |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 |
| secret | Y | api操作密钥(配置文件配置) |
| vhost | Y | 添加的流的虚拟主机，例如`__defaultVhost__` |
| schema | Y | 协议，例如 rtsp或rtmp |
| app | Y | 添加的流的应用名，例如live |
@@ -1230,7 +1230,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 |
| :----: | :------: | :----------------------------------------------------------: |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 |
| secret | Y | api操作密钥(配置文件配置) |
| key | Y | addStreamPusherProxy接口返回的key |
- 响应：
@@ -1253,7 +1253,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 |
| :----: | :------: | :----------------------------------------------------------: |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 |
| secret | Y | api操作密钥(配置文件配置) |
- 响应：
@@ -1278,7 +1278,7 @@ typedef enum {
| 参数 | 是否必选 | 释意 |
| :----: | :------: | :----------------------------------------------------------: |
| secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 |
| secret | Y | api操作密钥(配置文件配置) |
| schema | Y | 协议，例如 rtsp或rtmp |
| vhost | Y | 虚拟主机，例如`__defaultVhost__` |
| app | Y | 应用名，例如 live |
@@ -1301,6 +1301,3 @@ typedef enum {
]
}
```