API 文档

获取在线流的推流数据

最近更新时间:2021-03-01 08:05:55

我的收藏

1. 接口描述

接口请求域名: live.tencentcloudapi.com 。

查询所有实时流的推流信息,包括客户端IP,服务端IP,帧率,码率,域名,开始推流时间。

默认接口请求频率限制:500次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeLiveStreamPushInfoList。
Version String 公共参数,本接口取值:2018-08-01。
Region String 公共参数,本接口不需要传递此参数。
PushDomain String 推流域名。
AppName String 推流路径,与推流和播放地址中的AppName保持一致,默认为live。
PageNum Integer 页数,
范围[1,10000],
默认值:1。
PageSize Integer 每页个数,
范围:[1,1000],
默认值: 200。

3. 输出参数

参数名称 类型 描述
DataInfoList Array of PushDataInfo 直播流的统计信息列表。
TotalNum Integer 所有在线流的总数量。
TotalPage Integer 总页数。
PageNum Integer 当前数据所在页码。
PageSize Integer 每页的在线流的个数。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

https://live.tencentcloudapi.com/?Action=DescribeLiveStreamPushInfoList
&PushDomain=5000.pushdomain.com
&AppName=live
&PageNum=1
&PageSize=1000
&<公共请求参数>

输出示例

{
  "Response": {
    "DataInfoList": [
      {
        "StreamName": "test1",
        "AppName": "live",
        "ClientIp": "127.0.0.1",
        "ServerIp": "127.0.0.1",
        "VideoFps": 100,
        "VideoSpeed": 100,
        "AudioFps": 40,
        "AudioSpeed": 40,
        "AsampleRate": 48000,
        "PushDomain": "5000.pushdomain.com",
        "BeginPushTime": "2019-02-01 00:00:00",
        "Acodec": "AAC",
        "Vcodec": "H264",
        "Resolution": "350*350",
        "MetaAudioSpeed": 22,
        "MetaFps": 30,
        "MetaVideoSpeed": 4885
      }
    ],
    "PageNum": 1,
    "PageSize": 1000,
    "TotalNum": 1,
    "TotalPage": 1,
    "RequestId": "8e50cdb5-56dc-408b-89b0-31818958d424"
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.HasNotLivingStream 无在线流。
FailedOperation.QueryUploadInfoFailed 查询 upload 信息失败。
InternalError 内部错误。
InternalError.InvalidRequest 无效的请求。
InternalError.QueryProIspPlayInfoError 按省份运营商查询播放信息失败。
InternalError.QueryUploadInfoFailed 查询 upload 信息失败。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
目录