直播备用流切换

最近更新时间:2024-08-14 02:02:32

我的收藏

1. 接口描述

接口请求域名: live.tencentcloudapi.com 。

调用该接口实现切换当前播放所使用的主备流。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:SwitchBackupStream。
Version String 公共参数,本接口取值:2018-08-01。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-bangkok, ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai 。
PushDomainName String 推流域名。
示例值:5000.livepush.com
AppName String 应用名称。
示例值:live
StreamName String 流名称。
示例值:test
UpstreamSequence String 查询接口获取到该流所有在推的上行 Sequence。指定要切到的目标上行 Sequence。
示例值:843110096313761792

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

对主备流进行切换。

输入示例

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

{
    "PushDomainName": "abc",
    "AppName": "abc",
    "StreamName": "abc",
    "UpstreamSequence": "843110096313761792"
}

输出示例

{
    "Response": {
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.CallOtherSvrFailed 调用内部服务失败。
ResourceNotFound.ForbidService 用户被禁用。
ResourceNotFound.FreezeService 用户服务被冻结。
ResourceNotFound.StopService 账号停服,请先冲正开通服务后再操作。
ResourceNotFound.UserDisableService 用户主动停服。