文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>云直播>API 文档>域名管理相关接口>获取直播源站配置信息

获取直播源站配置信息

最近更新时间：2026-05-08 02:13:31

我的收藏

本页目录：

1. 接口描述

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

获取直播源站配置信息，支持直播源站格式。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeOriginStreamInfo。
Version 是 String 公共参数，本接口取值：2018-08-01。
Region 否 String 公共参数，本接口不需要传递此参数。
DomainName 是 String

域名。


示例值：autotest-third-source01.elementtest.org

3. 输出参数

参数名称 类型 描述
Status Integer

配置状态信息：0 配置中，1 成功，2 关闭中，3 关闭成功。


示例值：0
CdnStreamPlayType Array of String

播放类型。


示例值：["rtmp"]
OriginStreamType Integer

原站配置类型：1 直播原站。
2 streamPackage。


示例值：1
OriginStreamPlayType String

原站播放类型。


示例值：customization
OriginAddressType Integer

原站地址类型：1 ip，2 域名。


示例值：1
OriginAddress Array of String

原站地址信息，每项用分号分割域名（ip）、端口信息。
端口为空也要带上分号，表示取默认端口。


示例值：["1.2.3.4:8800"]
OriginTimeout Integer

超时时间，单位 ms。


注意：此字段可能返回 null，表示取不到有效值。
示例值：10000
OriginRetryTimes Integer

重试次数，单位 次。


注意：此字段可能返回 null，表示取不到有效值。
示例值：1
TimeJitter String

时间戳修正，可取值：on、off。
当原站播放协议为 rtmp、flv 时，传递该字段才会生效。


注意：此字段可能返回 null，表示取不到有效值。
示例值：off
HlsPlayFragmentCount Integer

分片数，单位 个。


注意：此字段可能返回 null，表示取不到有效值。
示例值：3
HlsPlayFragmentDuration Integer

分片时长，单位 ms。


注意：此字段可能返回 null，表示取不到有效值。
示例值：3500
PassThroughHttpHeader String

是否透传 http 头信息，可取值：on、off。
当原站播放协议为 hls 时，传递该字段才会生效。


注意：此字段可能返回 null，表示取不到有效值。
示例值：off
PassThroughResponse String

是否透传相应，可取值：on、off。
当原站播放协议为 hls 时，传递该字段才会生效。


注意：此字段可能返回 null，表示取不到有效值。
示例值：off
PassThroughParam String

是否透传参数，可取值：on、off。
当原站播放协议为 hls 时，传递该字段才会生效。


注意：此字段可能返回 null，表示取不到有效值。
示例值：off
OriginHost String

原站 host。
当原站播放协议为 hls 时，传递该字段才会生效。


注意：此字段可能返回 null，表示取不到有效值。
示例值：test.play.fake.com
IndexerCache Integer

索引缓存，单位 ms。
当原站播放协议为 hls 时，传递该字段才会生效。


注意：此字段可能返回 null，表示取不到有效值。
示例值：1000
FragmentCache Integer

分片缓存，单位 ms。
当原站播放协议为 hls 时，传递该字段才会生效。


注意：此字段可能返回 null，表示取不到有效值。
示例值：1000
DomainName String

域名。


注意：此字段可能返回 null，表示取不到有效值。
示例值：autotest-third-source01.elementtest.org
UsingHttps String

https 回源，可取值：on、off。
当原站播放协议为flv、hls时，传递此字段才会生效。


注意：此字段可能返回 null，表示取不到有效值。
示例值：off
CacheFollowOrigin String

是否遵循原站，可取值：on、off。
当原站播放协议为hls时，此字段才会生效。


注意：此字段可能返回 null，表示取不到有效值。
示例值：off
CacheStatusCode Array of String

状态码缓存，数组元素格式：
cacheKey:interval
cacheKey 可取值：cache_400_sec、cache_403_sec、cache_404_sec、cache_405_sec、cache_500_sec、cache_503_sec、cache_504_sec。
interval 单位 ms。
当原站播放协议为hls时，此字段才会生效。


注意：此字段可能返回 null，表示取不到有效值。
示例值：["cache_400_sec:1"]
UrlReplaceRules Array of String

url改写， 格式为： url1<|>url2; 其中，<|> 为分隔符。
url1、url2 长度限制100，不可包含特殊字符。
当原站播放协议为hls时，此字段才会生效。


注意：此字段可能返回 null，表示取不到有效值。
示例值：["/live<|>/live2","pgm<|>clean"]
OptionsRequest String

是否 options 支持，可取值：on、off。
当原站播放协议为hls时，此字段才会生效。


注意：此字段可能返回 null，表示取不到有效值。
示例值：off
FollowRedirect String

是否 follow 301/302，可取值：on、off。
当原站播放协议为hls时，此字段才会生效。


注意：此字段可能返回 null，表示取不到有效值。
示例值：on
StreamPackageRegion Array of String

源站类型 OriginStreamType 为 2 时，该字段有效。 代表源站地址 OriginAddress 对应的地区 region。


注意：此字段可能返回 null，表示取不到有效值。
示例值：["ap-mumbai"]
CustomerName String

客户名。


注意：此字段可能返回 null，表示取不到有效值。
示例值：customer1
IndexerKeepParam Array of String

当 OriginStreamPlayType 为 hls 时生效，设置索引缓存保留指定参数列表，最多支持 30 组，每个参数小于等于 20 字符。


注意：此字段可能返回 null，表示取不到有效值。
示例值：["key1","key2"]
FragmentKeepParam Array of String

当 OriginStreamPlayType 为 hls 时生效，设置分片缓存保留指定参数列表，最多支持 30 组，每个参数小于等于 20 字符。


注意：此字段可能返回 null，表示取不到有效值。
示例值：["key1","key2"]
MediaPackageType String

当 OriginStreamType = 2 时有效，表示 mediapackage 具体类型：
media_package => 仅配置普通频道。
media_package_pure_ad => 仅配置广告。
media_package_mix_ad => 同时配置普通频道和广告。


注意：此字段可能返回 null，表示取不到有效值。
示例值：media_package
MediaPackageChannelTypes Array of String

当 OriginStreamType = 2 且 MediaPackageType = media_package 时有效，表示 mediapackage 频道类型，可组合如下值：normal（频道）、ssai（广告）、linear_assembly（线性组装）。


示例值：["normal"]
IndexerHeader Array of String

当 OriginStreamPlayType 为 hls 时生效，设置索引自定义 header，每一组参数、取值用空格分开。


注意：此字段可能返回 null，表示取不到有效值。
示例值：["k1:v1","k2:v2"]
FragmentHeader Array of String

当 OriginStreamPlayType 为 hls 时生效，设置分片自定义 header，每一组参数、取值用空格分开。


注意：此字段可能返回 null，表示取不到有效值。
示例值：["k1:v1","k2:v2"]
CustomizationRules Array of OriginStreamCustomizationRule

自定义规则列表。


注意：此字段可能返回 null，表示取不到有效值。
CacheFormatRule Integer

缓存格式规则。
0：默认格式。
1：云直播源站格式。
当 OriginStreamPlayType 为 customization 时候生效。


示例值：1
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取直播源站配置信息

输入示例

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

{
    "DomainName": "autotest-third-source01.elementtest.org"
}

输出示例

{
    "Response": {
        "Status": 0,
        "DomainName": "autotest-third-source01.elementtest.org",
        "CdnStreamPlayType": [
            "rtmp",
            "hls",
            "flv"
        ],
        "OriginStreamType": 1,
        "OriginStreamPlayType": "rtmp",
        "OriginAddressType": 1,
        "OriginAddress": [
            "60.215.15.235:1935",
            "32.16.116.191:1935"
        ],
        "OriginTimeout": 10000,
        "OriginRetryTimes": 10,
        "TimeJitter": "off",
        "HlsPlayFragmentCount": 3,
        "HlsPlayFragmentDuration": 3000,
        "PassThroughHttpHeader": "off",
        "PassThroughResponse": "off",
        "PassThroughParam": "off",
        "OriginHost": null,
        "IndexerCache": null,
        "FragmentCache": null,
        "UsingHttps": "off",
        "CacheFollowOrigin": "off",
        "CacheStatusCode": [],
        "UrlReplaceRules": [],
        "OptionsRequest": "off",
        "FollowRedirect": "on",
        "CustomerName": null,
        "StreamPackageRegion": null,
        "IndexerKeepParam": [],
        "FragmentKeepParam": [],
        "MediaPackageType": null,
        "IndexerHeader": [],
        "FragmentHeader": [],
        "RequestId": "85f82143-b8a2-467c-bcff-6729fd7a471f"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError.DBError DB执行错误。
InvalidParameter 参数错误。
ResourceNotFound 资源不存在。
ResourceNotFound.ForbidService 用户被禁用。
ResourceNotFound.FreezeService 用户服务被冻结。
ResourceNotFound.InvalidUser 用户不支持此接口。
ResourceNotFound.StopService 账号停服，请先冲正开通服务后再操作。
ResourceNotFound.UserDisableService 用户主动停服。
中国站