tencent cloud

APIs

文档APIsStreamLinkFlow APIsDescribeStreamLinkFlowRealtimeStatus

查询流实时状态接口

下载
聚焦模式
字号
最后更新时间: 2026-06-08 11:31:07

1. 接口描述

接口请求域名: mdc.intl.tencentcloudapi.com 。

实时查询流的当前状态

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:DescribeStreamLinkFlowRealtimeStatus。
Version 是 String 公共参数,本接口取值:2020-08-28。
Region 是 String 公共参数,详见产品支持的 地域列表。
FlowId 是 String 流ID。
InputIds.N 否 Array of String 输入id数组,如果输入输出数组都为空,则代表全量查询。
OutputIds.N 否 Array of String 输出id数组,如果输入输出数组都为空,则代表全量查询。

3. 输出参数

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

4. 示例

示例1 请求示例

输入示例

POST / HTTP/1.1
Host: mdc.intl.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. 开发者资源

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameter.Id Id无效。
InvalidParameter.NotFound 查不到信息。

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈