直播流状态查询
更新时间 2023-12-08 10:34:04
最近更新时间: 2023-12-08 10:34:04
接口功能介绍
通过本接口可查询流的在线状态。
使用说明
单个用户一分钟限制调用10000次,并发不超过100。
接口详情
请求方式:POST
请求路径:/live/statistics/query-stream-status
请求参数
| 参数 | 类型 | 名称 | 是否必填 | 说明 |
|---|---|---|---|---|
| domain | string | 域名 | 是 | - |
| app | string | 发布点 | 否 | 不传或传空默认返回所有 |
| stream | string | 流名 | 否 | 不传或传空默认返回所有 |
响应参数
| 参数 | 类型 | 说明 |
|---|---|---|
| code | int | 状态码 |
| message | string | 描述信息 |
| total_num | int | 总数量 |
| result | list | 返回结果列表 |
| result[*].heart_time | string | 最新时间 |
| result[*].domain | string | 域名 |
| result[*].app | string | 应用名称 |
| result[*].stream | string | 流名称 |
| result[*].online | string | 流状态。取值0和1;0表示查询的流已经结束推流,1表示当前在线流 |
| result[*].start_time | string | 推流开始时间 |
| result[*].client_ip | string | 主播推流端IP |
| result[*].server_ip | string | cdn推流节点IP |
示例
请求路径:https://cdnapi-global.ctapi.ctyun.cn/live/statistics/query-stream-status
请求示例
{
"app": "app-a",
"stream": "stream-a",
"domain": "ctyun.cn"
}
正常响应示例
{
"code": 100000,
"message": "success",
"total_num": 1,
"result": [
{
"app": "app-a",
"start_time": "1617850720.201",
"stream": "stream-a",
"heart_time": "1617850799.221",
"domain": "ctyun.cn",
"server_ip": "36.111.140.1",
"online": "1",
"client_ip": "36.111.140.2"
}
]
}
错误码请参考:参数code和message含义