接口功能介绍
支持视频直播产品的发布点、流名粒度的配置。
使用说明
- 新增发布点/流名粒度配置之前,保证域名已创建过,且没有在途工单;
- 本接口新增分2种场景,①新增发布点配置;②新增流名配置
- 可通过查询发布点/流名粒度配置接口查询新增的发布点配置ID和流名配置ID
- 单个用户一分钟限制调用10次
接口详情
请求方式:POST
请求路径:/live/app-and-stream/create-app-and-stream
请求参数
参数 | 参数类型 | 名称 | 是否必填 | 说明 | 下级对象 |
---|---|---|---|---|---|
product_code | string | 产品类型 | 是 | 支持:“005”(视频直播) | |
domain | string | 域名 | 是 | 加速域名 | |
apps_conf | list | 发布点配置 | 否 | 发布点配置集合 | apps_conf_single |
streams_conf | list | 流名配置 | 否 | 流名配置集合 | streams_conf_single |
apps_conf_single
参数 | 类型 | 名称 | 是否必填 | 说明 | 下级对象 |
---|---|---|---|---|---|
app_name | string | 发布点 | 是 | 一次只能提交1个频道名 支持精确匹配和模糊匹配(支持字母、数字、-、*,但不能直接传“**”),长度限制为128个字符 |
|
third_push | object | 转推任务 | 否 | 只支持配置一个转推任务,当前只支持绑定推流域名 | third_push |
time_shift | object | 时移任务 | 否 | 只支持配置一个时移任务,当前只支持绑定推流域名 | time_shift |
streams_conf_single
参数 | 类型 | 名称 | 是否必填 | 说明 | 下级对象 |
---|---|---|---|---|---|
app_name | string | 发布点 | 是 | 一次只能提交1个频道名 支持精确匹配和模糊匹配(支持字母、数字、-、 ,但不能直接传“ ”),长度限制为128个字符 |
|
stream_name | string | 流名 | 是 | 支持精确匹配和模糊匹配(支持字母、数字、-、,但不能直接传“ ”),长度限制为128个字符 1)直接写流名称则仅匹配该流名称,示例:liveStreamA; 2)模糊匹配,示例:live* |
|
third_push | object | 转推任务 | 否 | 只支持配置一个转推任务,当前只支持绑定推流域名 | third_push |
time_shift | object | 时移任务 | 否 | 只支持配置一个时移任务,当前只支持绑定推流域名 | time_shift |
third_push
参数 | 类型 | 名称 | 是否必填 | 说明 | 下级对象 |
---|---|---|---|---|---|
switch | string | 转推开关 | 是 | 转推开关,on(开启)、off(关闭) | |
push_list | list | 转推列表 | 否 | 转推列表,开关开启时必填 | push_list_single |
push_list_single
参数 | 类型 | 名称 | 是否必填 | 说明 |
---|---|---|---|---|
origin | string | 转推目标 | 是 | 转推目标ip或域名,支持ipv4、ipv6和域名 |
port | string | 转推端口 | 否 | 转推目标端口,不填默认1935 |
host | string | 转推host | 否 | 转推使用的请求头host |
time_shift
参数 | 类型 | 名称 | 是否必填 | 说明 |
---|---|---|---|---|
switch | string | 时移开关 | 是 | 取值:on(开启)、off(关闭) |
max_playback_time | string | 时移任务回看时长 | 否 | 取值:30s~30d(time格式,30s到30天); 默认一小时,支持的单位: s、m、 h、d |
module_id | string | 模板id | 是 | 时移需要绑定的录制模板id |
响应参数
参数 | 类型 | 说明 |
---|---|---|
code | int | 状态码 |
message | string | 描述信息 |
示例
请求路径:https://cdnapi-global.ctapi.ctyun.cn/live/app-and-stream/create-app-and-stream
请求示例
{
"product_code":"005",
"domain":"ctyun.cn",
"apps_conf": [
{
"app_name": "app333",
"time_shift": {
"switch": "on",
"max_playback_time": "32s",
"module_id": "d656acd5"
},
"third_push": {
"switch": "on",
"push_list": [
{
"origin": "1.1.1.1",
"host": "ctyun.cn1",
"port": "22"
}
]
}
}
],
"streams_conf": [
{
"app_name": "app-6",
"stream_name": "ffff",
"time_shift": {
"switch": "on",
"max_playback_time": "32s",
"module_id": "d656ed5"
},
"third_push": {
"switch": "on",
"push_list": [
{
"origin": "1.1.1.1",
"host": "ctyun.cn2"
}
]
}
}
]
}
正常响应示例
{
"code": 100000,
"message": "success"
}
错误码请参考:参数code和message含义