1. 接口描述
接口请求域名: live.tencentcloudapi.com 。
变更直播源站配置,支持直播源站格式。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ModifyOriginStreamInfo。 |
| Version | 是 | String | 公共参数,本接口取值:2018-08-01。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| DomainName | 是 | String | 域名。 示例值:www.playtest.com |
| OriginStreamPlayType | 是 | String | 源站播放协议,可取值:rtmp、flv、hls、dash、hls|dash、customization。 示例值:hls |
| CdnStreamPlayType.N | 是 | Array of String | 播放协议,可取值:rtmp、flv、hls、dash、hls|dash、customization。 示例值:["customization"] |
| OriginStreamType | 是 | Integer | 原站类型: 示例值:1 |
| OriginAddress.N | 是 | Array of String | 原站地址信息,每项用冒号分割域名(ip)、端口信息。 示例值:["1.2.3.4:80"] |
| OriginAddressType | 是 | Integer | 原站地址类型: 示例值:1 |
| CustomerName | 否 | String | 自定义名称 示例值:customer1 |
| OriginHost | 否 | String | 原站 host。 示例值:www.test.host.com |
| OriginTimeout | 否 | Integer | 超时时间,单位 ms,取值范围:1 ~ 60000,默认值:10000。 示例值:10000 |
| OriginRetryTimes | 否 | Integer | 重试次数,单位 次,取值范围:1 ~ 10,默认值:10。 示例值:10 |
| PassThroughHttpHeader | 否 | String | 是否透传 http 头信息,可取值:on、off。 示例值:off |
| PassThroughResponse | 否 | String | 是否透传相应,可取值:on、off。 示例值:off |
| PassThroughParam | 否 | String | 是否透传参数,可取值:on、off。 示例值:off |
| IndexerCache | 否 | Integer | 索引缓存,单位 ms,取值范围:1 ~ 60000,默认值:10000。 示例值:10000 |
| FragmentCache | 否 | Integer | 分片缓存,单位 ms,取值范围:1 ~ 60000,默认值:10000。 示例值:10000 |
| HlsPlayFragmentCount | 否 | Integer | 分片数,单位 个,取值范围:1 ~ 10,默认值:3。 示例值:3 |
| HlsPlayFragmentDuration | 否 | Integer | 分片时长,单位 ms,取值范围:1 ~ 10000,默认值:3000。 示例值:3000 |
| TimeJitter | 否 | String | 时间戳修正,可取值:on、off,默认值:off。 示例值:off |
| UsingHttps | 否 | String | https 回源,可取值:on、off,默认值:off。 示例值:off |
| CacheFollowOrigin | 否 | String | 遵循原站,可取值:on、off,默认值:off。 示例值:off |
| CacheStatusCode.N | 否 | Array of String | 状态码缓存,数组元素格式: 示例值:["cache_400_sec:1"] |
| UrlReplaceRules.N | 否 | Array of String | url改写, 格式为: url1<|>url2; 其中,<|> 为分隔符。 示例值:["/live<|>/live2"] |
| OptionsRequest | 否 | String | options 支持,可取值:on、off,默认值:off。 示例值:off |
| FollowRedirect | 否 | String | follow 301/302,可取值:on、off,默认值:off。 示例值:off |
| IndexerKeepParam.N | 否 | Array of String | 当 OriginStreamPlayType 为 hls 时生效,设置索引缓存保留指定参数列表,最多支持 30 组,每个参数小于等于 20 字符。 示例值:["key1","key2"] |
| FragmentKeepParam.N | 否 | Array of String | 当 OriginStreamPlayType 为 hls 时生效,设置分片缓存保留指定参数列表,最多支持 30 组,每个参数小于等于 20 字符。 示例值:["key1","key2"] |
| MediaPackageType | 否 | String | 当 OriginStreamType = 2 时有效,表示 mediapackage 具体类型: 示例值:media_package_pure_ad |
| MediaPackageChannelTypes.N | 否 | Array of String | 当 OriginStreamType = 2 且 MediaPackageType = media_package 时有效,表示 mediapackage 频道类型,可组合如下值:normal(频道)、ssai(广告)、linear_assembly(线性组装)。 示例值:["normal"] |
| IndexerHeader.N | 否 | Array of String | 当 OriginStreamPlayType 为 hls 时生效,设置索引自定义 header,最大支持 10 组,每一组参数、取值用空格分开,允许字符规则如下: 示例值:["k1:v1","k2:v2"] |
| FragmentHeader.N | 否 | Array of String | 当 OriginStreamPlayType 为 hls 时生效,设置分片自定义 header,最大支持 10 组,每一组参数、取值用空格分开,允许字符规则如下: 示例值:["k1:v1","k2:v2"] |
| CustomizationRules.N | 否 | Array of OriginStreamCustomizationRule | 自定义回源规则列表,当 OriginStreamPlayType 为 customization 时候生效。 |
| CacheFormatRule | 否 | Integer | 缓存格式规则。 示例值:1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 ModifyOriginStreamInfo
输入示例
POST / HTTP/1.1
Host: live.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyOriginStreamInfo
<公共请求参数>
{
"DomainName": "www.test.live",
"OriginStreamPlayType": "hls",
"CdnStreamPlayType": [
"hls"
],
"OriginStreamType": 1,
"OriginAddress": [
"81.68.241.194:8082"
],
"OriginAddressType": 1
}
输出示例
{
"Response": {
"RequestId": "2b73d79c-2726-4906-810c-7ad2f2c6f76e"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError.DBError | DB执行错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.MatchRuleOnlySupportNormalSuffix | 匹配规则仅支持音视频格式后缀。 |
| ResourceNotFound.ForbidService | 用户被禁用。 |
| ResourceNotFound.FreezeService | 用户服务被冻结。 |
| ResourceNotFound.InvalidUser | 用户不支持此接口。 |
| ResourceNotFound.StopService | 账号停服,请先冲正开通服务后再操作。 |
| ResourceNotFound.UserDisableService | 用户主动停服。 |