新增發布點/流名粒度配置
更新時間 2023-11-09 14:58:36
最近更新時間: 2023-11-09 14:58:36
分享文章
接口功能介紹
支持視頻直播產品的發布點、流名粒度的配置。
使用說明
- 新增發布點/流名粒度配置之前,保證域名已創建過,且沒有在途工單;
- 本接口新增分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 | 描述信息 |
示例
請求路徑://cdnapi-global.ctapi.daliqc.cn/live/app-and-stream/create-app-and-stream
請求示例
{
"product_code":"005",
"domain":"daliqc.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": "daliqc.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": "daliqc.cn2"
}
]
}
}
]
}
正常響應示例
{
"code": 100000,
"message": "success"
}
錯誤碼請參考:參數code和message含義