媒体处理查询流实时状态接口-媒体传输相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： mps.tencentcloudapi.com 。

实时查询流的当前状态

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeStreamLinkFlowRealtimeStatus。
Version	是	String	公共参数，本接口取值：2019-06-12。
Region	是	String	公共参数，详见产品支持的地域列表。
FlowId	是	String	流ID。示例值：0176ac7f1af20956b92d2aad1e6d
InputIds.N	否	Array of String	输入id数组，如果输入输出数组都为空，则代表全量查询。示例值：["0176ac7f1af3","0956b92d2aad1e6e"]
OutputIds.N	否	Array of String	输出id数组，如果输入输出数组都为空，则代表全量查询。示例值：["0178c3f4bceb09","56b92d149e1b5d"]

3. 输出参数

参数名称	类型	描述
Timestamp	Integer	查询时间，单位s。示例值：1618543864
Datas	Array of FlowRealtimeStatusItem	实时数据信息列表。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeStreamLinkFlowRealtimeStatus
<公共请求参数>

{
    "FlowId": "0176ac7f1af20956b92d2aad1e6d",
    "InputIds": [
        "0176ac7f1af30956b92d2aad1e6e"
    ],
    "OutputIds": [
        "0178c3f4bceb0956b92d149e1b5d"
    ]
}

输出示例

{
    "Response": {
        "Timestamp": 1618543864,
        "RequestId": "xx",
        "Datas": [
            {
                "Protocol": "xx",
                "ConnectServerIP": "xx",
                "RTMPStatus": [
                    {}
                ],
                "OutputId": "xx",
                "FlowId": "xx",
                "InputId": "xx",
                "CommonStatus": {
                    "State": "xx",
                    "Reconnections": 0,
                    "Bitrate": 0,
                    "Mode": "xx",
                    "ConnectedTime": 0
                },
                "SRTStatus": [
                    {}
                ],
                "Type": "xx",
                "RTPStatus": {
                    "Packets": 0
                }
            },
            {
                "Protocol": "xx",
                "ConnectServerIP": "xx",
                "RTMPStatus": [
                    {}
                ],
                "OutputId": "xx",
                "FlowId": "xx",
                "InputId": "xx",
                "CommonStatus": {
                    "State": "xx",
                    "Reconnections": 0,
                    "Bitrate": 0,
                    "Mode": "xx",
                    "ConnectedTime": 0
                },
                "SRTStatus": [
                    {}
                ],
                "Type": "xx",
                "RTPStatus": {
                    "Packets": 0
                }
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError	内部错误。
InvalidParameter.Id	InvalidParameter.Id
InvalidParameter.NotFound	InvalidParameter.NotFound

查询流实时状态接口

本页目录：