1. 接口描述
接口请求域名: live.tencentcloudapi.com 。
创建临时拉流转推任务,目前限制添加10条任务。
该接口已下线,请使用新接口 CreateLivePullStreamTask。
注意:该接口用于创建临时拉流转推任务,
拉流源地址即 FromUrl 可以是腾讯或非腾讯数据源,
但转推目标地址即 ToUrl 目前限制为已注册的腾讯直播域名。
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreatePullStreamConfig。 |
Version | 是 | String | 公共参数,本接口取值:2018-08-01。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
FromUrl | 是 | String | 源 Url ,用于拉流的地址。目前可支持直播流及点播文件。 注意: 1. 多个点播url之间使用空格拼接。 2. 目前上限支持10个url。 3. 目前不支持https协议。 4. 支持拉流文件格式:flv,rtmp,hls,mp4。 示例值:rtmp://5000.liveplay.myqcloud.com/live/stream1 |
ToUrl | 是 | String | 目的 Url ,用于推流的地址,目前限制该目标地址为腾讯域名。 仅支持:rtmp 协议。 示例值:rtmp://5000.livepush.myqcloud.com/live/stream2 |
AreaId | 是 | Integer | 选择完成转拉推的服务所在区域: 1-深圳, 2-上海, 3-天津, 4-中国香港。 示例值:1 |
IspId | 是 | Integer | 选择完成转拉推服务使用的运营商网络: 1-电信, 2-移动, 3-联通, 4-其他。 注:AreaId 为4的时候,IspId 只能为其他。 示例值:1 |
StartTime | 是 | String | 开始时间。 使用 UTC 格式时间, 例如:2019-01-08T10:00:00Z。 注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 ISO 日期格式说明。 示例值:2018-12-31T11:02:00Z |
EndTime | 是 | String | 结束时间,注意: 1. 结束时间必须大于开始时间; 2. 结束时间和开始时间必须大于当前时间; 3. 结束时间 和 开始时间 间隔必须小于七天。 使用 UTC 格式时间, 例如:2019-01-08T10:00:00Z。 注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 ISO 日期格式说明。 示例值:2018-12-31T12:02:00Z |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ConfigId | String | 配置成功后的 ID。 示例值:123 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例
输入示例
POST / HTTP/1.1
Host: live.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePullStreamConfig
<公共请求参数>
{
"AreaId": "1",
"ToUrl": "rtmp://5000.livepush.myqcloud.com/live/stream2",
"FromUrl": "rtmp://5000.liveplay.myqcloud.com/live/stream1",
"IspId": "1",
"StartTime": "2018-12-31T11:02:00Z",
"EndTime": "2018-12-31T12:02:00Z"
}
输出示例
{
"Response": {
"ConfigId": "123",
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}
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.GetBizidError | 获取用户账号错误。 |
InternalError.InvalidInput | 参数检校不通过。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
ResourceNotFound.ForbidService | 用户被禁用。 |
ResourceNotFound.FreezeService | 用户服务被冻结。 |
ResourceNotFound.StopService | 账号停服,请先冲正开通服务后再操作。 |
ResourceNotFound.UserDisableService | 用户主动停服。 |
ResourceNotFound.UserNotExist | 用户未注册直播。 |