1. 接口描述
接口请求域名: live.tencentcloudapi.com 。
返回正在直播中的流列表。适用于推流成功后查询在线流信息。
注意:
- 该接口仅提供辅助查询在线流列表功能,业务重要场景不可强依赖该接口。
- 该接口仅适用于流数少于2万路的情况,对于流数较大用户请联系售后。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeBackupStreamList。 |
Version | 是 | String | 公共参数,本接口取值:2018-08-01。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-bangkok, ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai 。 |
StreamName | 否 | String | 流名称,用于精确查询。 示例值:mystream |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
StreamInfoList | Array of BackupStreamGroupInfo | 主备流分组信息列表。 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例
查询在推的主备流。
输入示例
POST / HTTP/1.1
Host: live.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupStreamList
<公共请求参数>
{
"StreamName": "stream1"
}
输出示例
{
"Response": {
"RequestId": "4b3d1d04-6f79-4f56-a8e7-46de97de1713",
"StreamInfoList": [
{
"OptimalEnable": 0,
"HostGroupName": "",
"StreamName": "stream1",
"BackupList": [
{
"DomainName": "5000.livepush.com",
"AppName": "live",
"PublishTime": "2018-06-29T19:00:00Z",
"UpstreamSequence": "710313341080024595",
"SourceFrom": "直推流",
"MasterFlag": 0
},
{
"DomainName": "5000.livepush.com",
"AppName": "gifshow",
"PublishTime": "2018-06-29T19:00:00Z",
"UpstreamSequence": "710313341080024599",
"SourceFrom": "拉流转推(123)",
"MasterFlag": 1
}
]
}
]
}
}
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.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 | 用户未注册直播。 |