1. 接口描述
接口请求域名: live.tencentcloudapi.com 。
返回已经推过流的流列表。
注意:分页最多支持查询1万条记录,可通过调整查询时间范围来获取更多数据。
默认接口请求频率限制:300次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeLiveStreamPublishedList。 |
Version | 是 | String | 公共参数,本接口取值:2018-08-01。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
DomainName | 是 | String | 您的推流域名。 |
EndTime | 是 | String | 结束时间。 UTC 格式,例如:2016-06-30T19:00:00Z。 不超过当前时间。 注意:EndTime和StartTime相差不可超过30天。 |
StartTime | 是 | String | 起始时间。 UTC 格式,例如:2016-06-29T19:00:00Z。 最长支持查询60天内数据。 |
AppName | 否 | String | 推流路径,与推流和播放地址中的 AppName 保持一致,默认为 live。不支持模糊匹配。 |
PageNum | 否 | Integer | 取得第几页。 默认值:1。 |
PageSize | 否 | Integer | 分页大小。 最大值:100。 取值范围:10~100 之前的任意整数。 默认值:10。 |
StreamName | 否 | String | 流名称,支持模糊匹配。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
PublishInfo | Array of StreamName | 推流记录信息。 |
PageNum | Integer | 分页的页码。 |
PageSize | Integer | 每页大小 |
TotalNum | Integer | 符合条件的总个数。 |
TotalPage | Integer | 总页数。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例
输入示例
https://live.tencentcloudapi.com/?Action=DescribeLiveStreamPublishedList
&DomainName=5000.livepush.myqcloud.com
&AppName=live
&StreamName=test
&PageNum=1
&PageSize=10
&StartTime=2015-06-25T03:30:50Z
&EndTime=2015-12-26T03:30:50Z
&<公共请求参数>
输出示例
{
"Response": {
"PublishInfo": [
{
"AppName": "live",
"ClientIp": "180.163.8.244",
"DomainName": "5000.livepush.myqcloud.com",
"Duration": 10,
"Resolution": "640*352",
"StopReason": "客户端主动断流",
"StreamEndTime": "2019-01-04T11:59:58Z",
"StreamName": "test1",
"StreamStartTime": "2019-01-04T11:59:58Z"
}
],
"PageNum": 1,
"PageSize": 10,
"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。
- 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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.CallOtherSvrFailed | 调用内部服务失败。 |
InternalError | 内部错误。 |
InternalError.CallOtherSvrError | 调用内部服务错误。 |
InternalError.ConfigNotExist | 配置不存在。 |
InternalError.GetBizidError | 获取用户账号错误。 |
InternalError.GetStreamInfoError | 获取流信息失败。 |
InternalError.GetUpstreamInfoError | 获取直播源信息错误。 |
InternalError.NotPermmitOperat | 无权限操作。 |
InternalError.StreamStatusError | 流状态异常。 |
InternalError.UpdateDataError | 更新数据失败。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
ResourceNotFound.ForbidService | 用户被禁用。 |
ResourceNotFound.FreezeService | 用户服务被冻结。 |
ResourceNotFound.StopService | 账号停服,请先冲正开通服务后再操作。 |
ResourceNotFound.UserDisableService | 用户主动停服。 |
ResourceNotFound.UserNotExist | 用户未注册直播。 |