文档中心

查询推流流信息

最近更新时间：2024.04.22 15:52:28

首次发布时间：2024.03.25 15:32:46

调用 DescribeLivePushStreamInfoData 接口，查询已断开的推流流信息以及推流断开的原因。

注意事项

请求频率：单用户请求频率限制为 100 次/秒。

请求说明

请求方式：POST
请求地址：https://live.volcengineapi.com?Action=DescribeLivePushStreamInfoData&Version=2023-01-01

调试

API Explorer

您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeLivePushStreamInfoData`	接口名称。当前 API 的名称为 `DescribeLivePushStreamInfoData`。
Version	String	是	`2023-01-01`	接口版本。当前 API 的版本为 `2023-01-01`。

Body

参数	类型	是否必选	示例值	描述
DomainList	Array of String	否	`["push.example.com"]`	直播推流使用的域名列表，缺省为空，表示当前账号下所有域名。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看直播推流使用的域名。
App	String	否	`example_app`	应用名称，取值与直播流地址中 AppName 字段取值相同，默认为空，表示查询所有应用名称。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
Stream	String	否	`example_stream`	流名称，取值与直播流地址中 StreamName 字段取值相同，默认为空表示查询所有流名称。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。
StartTime	String	是	`2021-04-13T00:00:00+08:00`	查询的开始时间，RFC3339 格式的时间戳，精度为秒。说明支持查询最近 93 天以内的推流数据。
EndTime	String	是	`2021-04-14T00:00:00+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。说明支持查询最近 93 天以内的推流数据。
PageNum	Integer	否	`1`	查询数据的页码，默认为 `1`，表示查询第一页的数据，取值范围为正整数。
PageSize	Integer	否	`20`	每页显示的数据条数，默认为 `20`，取值范围为 [1,1000]。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构。

参数	类型	示例值	描述
DomainList	Array of String	`["push.example.com"]`	域名列表。
App	String	`live`	应用名称。
Stream	String	`example_stream`	流名称。
StartTime	String	`2021-04-13T00:00:00+08:00`	查询推流的开始时间，RFC3339 格式的时间字符串，精度为秒。
EndTime	String	`2021-04-14T00:00:00+08:00`	查询推流的结束时间，RFC3339 格式的时间字符串，精度为秒。
PushStreamInfoDataList	Array of PushStreamInfoDataList	`-`	在查询时间范围内进行推流并已断开的流信息。
Pagination	Object of Pagination	`-`	查询结果的分页信息。

PushStreamInfoDataList

参数	类型	示例值	描述
App	String	`example_app`	应用名称。
Stream	String	`example_stream`	流名称。
StartTime	String	`2021-04-13T00:00:00+08:00`	当前流的推流开始时间，RFC3339 格式的时间字符串，精度为秒。
EndTime	String	`2021-04-14T00:00:00+08:00`	当前流的推流结束时间，RFC3339 格式的时间字符串，精度为秒。
Duration	Integer	`100`	推流开始到结束的时长，单位为秒。
IP	String	`127.0.0.1`	推流客户端的 IP 地址，没有 IP 信息时返回为空。
StreamBreakReason	String	`对端主动断开链接`	推流断开原因，常见的断流原因参见回调内容说明-断流错误原因。

Pagination

参数	类型	示例值	描述
PageCur	Integer	`1`	查询数据的页码。
PageSize	Integer	`100`	每页显示的数据条数。
TotalCount	Integer	`1000`	查询时间范围内的流数据总条数。

请求示例

POST https://live.volcengineapi.com?Action=DescribeLivePushStreamInfoData&Version=2023-01-01
{
    "DomainList": [
        "push.example.com"
    ],
    "App": "live",
    "Stream": "example_stream",
    "StartTime": "2021-04-13T00:00:00+08:00",
    "EndTime": "2021-04-14T00:00:00+08:00"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "DescribeLivePushStreamInfoData",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "DomainList": [
            "push.example.com"
        ],
        "App": "live",
        "Stream": "exampel_stream",
        "StartTime": "2021-09-01T00:00:00+08:00",
        "EndTime": "2021-09-14T00:00:00+08:00",
        "PushStreamInfoDataList": [
            {
                "App": "live",
                "Stream": "example_stream",
                "StartTime": "2021-09-01T00:00:00+08:00",
                "EndTime": "2021-09-02T00:00:00+08:00",
                "Duration": 122345,
                "IP": "xx.xx.xx.xx",
                "StreamBreakReason": "重复推流"
            }
        ],
        "Pagination": {
            "PageCur": 1,
            "PageSize": 1000,
            "TotalCount": 2
        }
    }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码	错误码	错误信息	说明
400	InvalidParam	-	输入的参数无效或不符合要求，请参照请求参数说明进行检查。
500	InternalError	an internal error occurred, please contact the administrator.	出现内部错误，请联系技术支持。
502	InternalServiceError	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。

SDK

视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。