接口功能介绍
支持直播推流、拉流域名的创建。
使用说明
- 添加域名之前,您需要先开通对应产品类型的服务;
- 该域名必须已成功备案;
- 该域名之前未创建过,没有在途工单;
- 单个用户一分钟限制调用10次。
- 视频直播产品的域名分3种场景,①新增推流域名;②新增拉流域名,且拉流模式为推拉流;③新增拉流域名,且拉流模式为回源拉流
接口详情
请求方式:POST
请求路径:/live/domain/create-domain
请求参数
场景1:创建推流域名
参数 | 类型 | 名称 | 是否必填 | 说明 |
---|---|---|---|---|
product_code | string | 产品类型 | 是 | "005":视频直播 |
domain | string | 域名 | 是 | 推流域名 |
conf_type | int | 域名类型 | 是 | 固定值:2(直播推流) |
场景2:创建拉流域名(推拉流场景)
参数 | 类型 | 名称 | 是否必填 | 说明 |
---|---|---|---|---|
product_code | string | 产品类型 | 是 | "005":视频直播 |
domain | string | 域名 | 是 | 拉流域名 |
conf_type | int | 域名类型 | 是 | 固定值:1(直播拉流) |
pull_stream_mode | int | 拉流模式 | 是 | 固定值:0(推拉流) |
push_stream_domain | string | 关联推流域名 | 是 | 已创建的推流域名 |
场景3:创建拉流域名(回源拉流场景)
参数 | 类型 | 名称 | 是否必填 | 说明 |
---|---|---|---|---|
product_code | string | 产品类型 | 是 | "005":视频直播。 |
domain | string | 域名 | 是 | 拉流域名。 |
conf_type | int | 域名类型 | 是 | 1(直播拉流)。 |
pull_stream_mode | int | 拉流模式 | 是 | 1(回源拉流)。 |
rtmp_origin | list | rtmp协议回源参数 | 否 | rtmp_origin,flv_origin,flv_https_origin,hls_http_origin,hls_https_origin 5个为回源功能组,必填其中一个,可多个。 |
rtmp_origin[*].origin | string | 协议地址 | 是 | 当rtmp_origin有值时,该字段必填。 |
flv_origin | list | flv协议http回源参数 | 否 | rtmp_origin,flv_origin,flv_https_origin,hls_http_origin,hls_https_origin 5个为回源功能组,必填其中一个,可多个。 |
flv_origin[*].origin | string | 协议地址 | 是 | 当flv_origin有值时,该字段必填。 |
flv_https_origin | list | flv协议https回源参数 | 否 | rtmp_origin,flv_origin,flv_https_origin,hls_http_origin,hls_https_origin 5个为回源功能组,必填其中一个,可多个。 |
flv_https_origin[*]origin | str | flv协议地址 | 是 | 当flv_https_origin有值时,该字段必填,支持ipv4、ipv6、域名 |
hls_http_origin | list | hls协议回源参数 | 否 | rtmp_origin,flv_origin,flv_https_origin,hls_http_origin,hls_https_origin 5个为回源功能组,必填其中一个,可多个。 |
hls_http_origin[*].origin | string | 源站 | 是 | 当hls_http_origin有值时,该字段必填。 |
hls_https_origin | list | hls协议https回源参数 | 否 | rtmp_origin,flv_origin,flv_https_origin,hls_http_origin,hls_https_origin 5个为回源功能组,必填其中一个,可多个。 |
hls_https_origin[*]origin | str | 源站 | 是 | 当hls_https_origin有值时,该字段必填,支持ipv4、ipv6、域名 |
distribution_protocol | string | 播放协议 | 是 | 可以为flv,rtmp,hls, 多个以英文逗号隔开。 |
响应参数
参数 | 类型 | 说明 |
---|---|---|
code | int | 状态码 |
message | string | 描述信息 |
示例
请求路径:https://cdnapi-global.ctapi.ctyun.cn/live/domain/create-domain
请求示例
示例1:创建推流域名
{
"product_code":"005",
"domain":"push.ctyun.cn",
"conf_type":2
}
示例2:创建拉流域名(推拉流场景)
{
"product_code":"005",
"domain":"pull.ctyun.cn",
"conf_type":1,
"pull_stream_mode":0,
"push_stream_domain":"push.ctyun.cn"
}
示例3:创建拉流域名(回源拉流场景)
{
"product_code":"005",
"domain":"ctyun.cn",
"conf_type":1,
"pull_stream_mode":1,
"distribution_protocol":"hls",
"rtmp_origin":[{"origin":"rtmp.ctyun.com"}]
}
正常响应示例
{
"code": 100000,
"message": "success"
}
错误码请参考:API返回参数code和message含义