Skip to content

HTTP API接口

简介

MMS 是一个高性能的流媒体处理服务,提供完善的 HTTP RESTful API 接口,支持实时流管理、资源监控、录制控制等核心功能。

功能特性:

📊 实时流状态监控

⚖️ 服务器负载查询

🚫 异常流强制断开

🎥 流录制生命周期管理

🌐 动态拉流控制

🔒 JWT Token 鉴权

📦 JSON 数据格式交互

API 接口规范

基础信息

接口地址http://服务器ip:服务器端口/api/v1

鉴权方式:Authorization: Bearer <your_api_key>

响应格式:统一 JSON 结构

json
{
  "code": 0,
  "data": {},
  "message": "success"
}

配置

首先需要在顶层配置文件 config/mms.yaml 中开启http api:

yaml
http_api:
  enabled: on               # Enable
  port: 8080                # Listening port

api列表

路径方法功能
/api/versionGET返回服务器版本
/api/obj_countGET返回服务器各种重要对象的计数,可用于直观观察是否内存泄漏及泄漏点
/api/domain_appsGET返回服务器的域名配置列表及域名相关的app配置信息
/api/domain_streamsGET返回指定域名下的在线流
/api/app_streamsGET返回指定域名及app下的在线流
/api/cut_off_streamPOST踢掉某个流

Released under the MIT License.