m7s
  1. global
m7s
  • global
    • replay
      • replay mp4
      • replay ts
      • replay rtp
    • insert SEI
      POST
    • 热更新配置
      GET
    • 修改配置
      GET
    • 获取流详情
      GET
    • 关闭一个流
      GET
    • 停止远端推流
      GET
    • 摘要信息包括流列表
      GET
    • 所有插件信息
      GET
    • 获取远端拉流列表
      GET
    • 获取远端推流列表
      GET
  1. global

摘要信息包括流列表

GET
/api/summary
最后修改时间:2023-10-17 07:00:20
摘要信息,包含系统资源消耗以及流的简要信息

请求参数

Query 参数
format
string 
可选
yaml:返回yaml格式,为空返回json格式,json:返回统一json格式
示例值:
yaml
Header 参数
Accept
string 
是否是SSE请求
可选
示例值:
text/event-stream

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://localhost:8080/api/summary?format=yaml' \
--header 'Accept: text/event-stream'

返回响应

🟢200成功
application/json
Body
Address
string 
必需
Memory
object 
必需
Total
integer 
必需
Free
integer 
必需
Used
integer 
必需
Usage
number 
必需
CPUUsage
number 
必需
HardDisk
object 
必需
Total
integer 
必需
Free
integer 
必需
Used
integer 
必需
Usage
number 
必需
NetWork
array [object {5}] 
必需
Name
string 
必需
Receive
integer 
必需
Sent
integer 
必需
ReceiveSpeed
integer 
必需
SentSpeed
integer 
必需
Streams
array [object {7}] 
必需
Path
string 
可选
State
integer 
可选
Subscribers
integer 
可选
Tracks
array[string]
可选
StartTime
string 
可选
Type
string 
可选
BPS
integer 
可选
示例
{
  "Address": "",
  "Memory": {
    "Total": 16384,
    "Free": 4554,
    "Used": 11829,
    "Usage": 72.20091819763184
  },
  "CPUUsage": 24.87479134502895,
  "HardDisk": {
    "Total": 465,
    "Free": 93,
    "Used": 371,
    "Usage": 79.8827445109926
  },
  "NetWork": [
    {
      "Name": "lo0",
      "Receive": 40149468933,
      "Sent": 40149468933,
      "ReceiveSpeed": 0,
      "SentSpeed": 0
    },
    {
      "Name": "gif0",
      "Receive": 0,
      "Sent": 0,
      "ReceiveSpeed": 0,
      "SentSpeed": 0
    },
    {
      "Name": "stf0",
      "Receive": 0,
      "Sent": 0,
      "ReceiveSpeed": 0,
      "SentSpeed": 0
    },
    {
      "Name": "ap1",
      "Receive": 0,
      "Sent": 3525785,
      "ReceiveSpeed": 0,
      "SentSpeed": 0
    },
    {
      "Name": "en0",
      "Receive": 90575288807,
      "Sent": 23334199496,
      "ReceiveSpeed": 0,
      "SentSpeed": 0
    },
    {
      "Name": "awdl0",
      "Receive": 2425150,
      "Sent": 200705,
      "ReceiveSpeed": 0,
      "SentSpeed": 0
    },
    {
      "Name": "llw0",
      "Receive": 0,
      "Sent": 0,
      "ReceiveSpeed": 0,
      "SentSpeed": 0
    },
    {
      "Name": "en1",
      "Receive": 0,
      "Sent": 0,
      "ReceiveSpeed": 0,
      "SentSpeed": 0
    },
    {
      "Name": "en2",
      "Receive": 0,
      "Sent": 0,
      "ReceiveSpeed": 0,
      "SentSpeed": 0
    },
    {
      "Name": "en4",
      "Receive": 0,
      "Sent": 0,
      "ReceiveSpeed": 0,
      "SentSpeed": 0
    },
    {
      "Name": "en3",
      "Receive": 0,
      "Sent": 0,
      "ReceiveSpeed": 0,
      "SentSpeed": 0
    },
    {
      "Name": "bridge0",
      "Receive": 0,
      "Sent": 0,
      "ReceiveSpeed": 0,
      "SentSpeed": 0
    },
    {
      "Name": "utun0",
      "Receive": 0,
      "Sent": 604208,
      "ReceiveSpeed": 0,
      "SentSpeed": 0
    },
    {
      "Name": "utun1",
      "Receive": 0,
      "Sent": 604208,
      "ReceiveSpeed": 0,
      "SentSpeed": 0
    },
    {
      "Name": "utun2",
      "Receive": 0,
      "Sent": 604088,
      "ReceiveSpeed": 0,
      "SentSpeed": 0
    },
    {
      "Name": "en5",
      "Receive": 5805821,
      "Sent": 5627887,
      "ReceiveSpeed": 0,
      "SentSpeed": 0
    },
    {
      "Name": "utun3",
      "Receive": 1686680978,
      "Sent": 452937914,
      "ReceiveSpeed": 0,
      "SentSpeed": 0
    }
  ],
  "Streams": [
    {
      "Path": "live/test",
      "State": 1,
      "Subscribers": 0,
      "Tracks": [
        "pcma",
        "h264",
        "ps"
      ],
      "StartTime": "2023-05-29T19:07:37.349246+08:00",
      "Type": "PS",
      "BPS": 1082459
    }
  ]
}
🟢200yaml
🟢200统一 json
🟢200sse
上一页
停止远端推流
下一页
所有插件信息
Built with