批量修改域名配置
更新時間 2023-11-09 14:58:32
最近更新時間: 2023-11-09 14:58:32
分享文章
接口功能介紹
支持批量修改視頻直播產品的域名配置。
使用說明
- 修改域名之前,您需要先開通對應產品類型的服務,且保證資源包/按需服務有效;
- 該域名沒有在途工單;
- 調用接口成功僅代表成功進入配置下發流程,配置部署需要一些時間,請等待10分鐘后通過查詢域名配置接口查看配置是否下發完成;
- 單個用戶一分鐘限制調用10次
- 視頻直播產品的域名修改分3種場景,①修改推流域名;②修改拉流域名,且拉流模式為推拉流;③修改拉流域名,且拉流模式為回源拉流;
- 接口的 一級功能為增量更新,二級功能為全量更新 ,如可選擇只更新ip_access_control,但ip_access_control下的配置項需全量更新。
接口詳情
請求方式:POST
請求路徑:/live/domain/batch-update-configuration-information
請求參數
場景1:推流域名配置修改
| 參數 | 類型 | 名稱 | 是否必填 | 說明 |
|---|---|---|---|---|
| product_code | string | 產品類型 | 是 | 支持:"005":視頻直播,創建后不可修改 |
| domain | list | 推流域名列表 | 是 | 單次調用域名個數最多不超過20個 |
| ip_access_control | object | ip黑白名單 | 否 | 未傳代表不修改,有傳代表整個object全量修改,包括:開關、ip列表、黑白名單類型 |
| ip_access_control.switch | string | 開關 | 是 | 取值:on(開啟);off(關閉) |
| ip_access_control.type | int | 黑白名單類型 | 否 | 取值:0(黑名單);1(白名單),當ip_access_control.switch = on 時必填 |
| ip_access_control.list | list | ip列表 | 否 | 當ip_access_control.switch = on 時必填,支持ipv4、ipv6 |
| self_notice | object | 推流回調 | 否 | 不傳字段或者傳值為null代表不做修改,否則默認整體替換 |
| self_notice.switch | int | 推流回調開關 | 是 | 取值:on(開啟)、off(關閉); 開啟時,推流回調地址、推流回調host、開播通知uri和關播通知uri均必填 |
| self_notice.notify_address | string | 推流回調地址 | 否 | 支持ipv4、ipv6和域名 |
| self_notice.notify_port | int | 開關播通知的端口 | 否 | 開關播通知的端口,默認80 |
| self_notice.notify_host | string | 開關播請求使用的host頭 | 否 | 支持ipv4、ipv6和域名 |
| self_notice.notify_start_url_path | string | 開播通知uri | 否 | 示例:”/pushstart“ |
| self_notice.notify_stop_url_path | string | 關播通知uri | 否 | 示例:”/pushend“ |
| time_shift | object | 時移任務 | 否 | 不傳字段代表不做修改,否則默認整體替換,只支持配置一個時移任務; |
| time_shift.switch | string | 時移開關 | 是 | 取值:on(開啟)、off(關閉); |
| time_shift.max_playback_time | string | 時移任務回看時長 | 否 | 30s~30d(time格式,30s到30天); 默認一小時,支持的單位: s、m、 h、d |
| time_shift.module_id | string | 錄制模板id | 是 | 時移需要綁定的錄制模板id |
| third_push | object | 轉推 | 否 | 不傳字段或者傳值為null代表不做修改,否則默認整體替換 |
| third_push.switch | int | 轉推開關 | 是 | 取值:on(開啟)、off(關閉); |
| third_push.push_list | list | 轉推列表 | 否 | 開關開啟時必填,不支持存在重復的地址、端口、host組合 |
| third_push.push_list:origin | string | 轉推目標ip或域名 | 是 | 如果是ipv6地址需要加[],示例: [::1] |
| third_push.push_list:port | string | 轉推目標端口 | 否 | 默認1935 |
| third_push.push_list:host | string | 轉推使用的請求頭host | 否 | 當referer_control.switch = on 時,且referer_control.allow_empty=off時必填 |
場景2:拉流域名配置修改(推拉流場景)
| 參數 | 類型 | 名稱 | 是否必填 | 說明 |
|---|---|---|---|---|
| product_code | string | 產品類型 | 是 | "005":視頻直播,創建后不可修改 |
| domain | list | 拉流域名列表 | 是 | 單次調用域名個數最多不超過20個 |
| push_stream_domain | string | 關聯推流域名 | 否 | 已創建的推流域名 |
| ip_access_control | obj | ip黑白名單 | 否 | 未傳代表不修改,有傳代表整個obj全量修改 包括:開關、ip列表、黑白名單類型 |
| ip_access_control.switch | string | 開關 | 是 | 取值:on(開啟);off(關閉) |
| ip_access_control.type | int | 黑白名單類型 | 否 | 當ip_access_control.switch = on 時,必填 取值:0(黑名單);1(白名單) |
| ip_access_control.list | list | ip列表 | 否 | 當ip_access_control.switch = on 時,必填 支持ipv4、ipv6 |
| referer_control | obj | 防盜鏈 | 否 | 未傳代表不修改,有傳代表整個obj全量修改 包括:開關、是否允許空referer訪問、黑白名單類型、referer列表 |
| referer_control.switch | string | 開關 | 是 | 取值:on(開啟A)、off(關閉) |
| referer_control.allow_empty | string | 是否允許空referer訪問 | 否 | 當referer_control.switch = on 時,必填 取值:on(開啟), off(關閉) |
| referer_control.type | int | 類型 | 否 | 當referer_control.switch = on 時,必填 取值:0(黑名單);1(白名單) |
| referer_control.list | list | referer列表 | 否 | 當referer_control.switch = on 時必填 |
| https_switch | int | 開關 | 否 | 取值:0:關,1:開; |
| cert_name | str | 證書名 | 否 | 僅https_switch為1時生效 |
場景3:拉流域名配置修改(拉流回源場景)
| 參數 | 類型 | 名稱 | 是否必填 | 說明 |
|---|---|---|---|---|
| product_code | string | 產品類型 | 是 | "005":視頻直播,創建后不可修改 |
| domain | list | 拉流域名列表 | 是 | 單次調用域名個數最多不超過20個 |
| rtmp_origin | list | rtmp協議回源參數 | 否 | rtmp_origin,flv_origin,flv_https_origin,hls_http_origin,hls_https_origin為回源功能組 若不修改,則5個參數都不傳值;若修改,則5個參數一同修改,修改時這5個參數必填其中一個,可多個。 |
| rtmp_origin[*].origin | string | 協議地址 | 是 | 當rtmp_origin有值時,該字段必填,支持ipv4、ipv6、域名 |
| flv_origin | list | flv協議http回源參數 | 否 | rtmp_origin,flv_origin,flv_https_origin,hls_http_origin,hls_https_origin為回源功能組 若不修改,則5個參數都不傳值;若修改,則5個參數一同修改,修改時這5個參數必填其中一個,可多個。 |
| flv_origin[*].origin | string | 協議地址 | 是 | 當flv_origin有值時,必填 支持ipv4、ipv6、域名 |
| flv_https_origin | list | flv協議https回源參數 | 否 | rtmp_origin,flv_origin,flv_https_origin,hls_http_origin,hls_https_origin為回源功能組 若不修改,則5個參數都不傳值;若修改,則5個參數一同修改,修改時這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個參數都不傳值;若修改,則5個參數一同修改,修改時這5個參數必填其中一個,可多個。 |
| hls_http_origin[*].origin | string | 源站 | 是 | 當hls_http_origin有值時,該字段必填,支持ipv4、ipv6、域名 |
| hls_https_origin | list | hls協議回源參數 | 否 | rtmp_origin,flv_origin,flv_https_origin,hls_http_origin,hls_https_origin為回源功能組 若不修改,則5個參數都不傳值;若修改,則5個參數一同修改,修改時這5個參數必填其中一個,可多個。 |
| hls_https_origin*].origin | str | 源站 | 是 | 當hls_https_origin有值時,必填 支持ipv4、ipv6、域名 |
| distribution_protocol | string | 播放協議 | 否 | flv,rtmp,hls, 多個以逗號間隔 |
| ip_access_control | obj | ip黑白名單 | 否 | 未傳代表不修改,有傳代表整個obj全量修改 包括:開關、ip列表、黑白名單類型 |
| ip_access_control.switch | string | 開關 | 是 | 取值:on(開啟);off(關閉) |
| ip_access_control.type | int | 黑白名單類型 | 否 | 當ip_access_control.switch = on 時,必填 取值:0(黑名單);1(白名單) |
| ip_access_control.list | list | ip列表 | 否 | 當ip_access_control.switch = on 時,必填 支持ipv4、ipv6 |
| referer_control | obj | 防盜鏈 | 否 | 未傳代表不修改,有傳代表整個obj全量修改 包括:開關、是否允許空referer訪問、黑白名單類型、referer列表 |
| referer_control.switch | string | 開關 | 是 | 取值:on(開啟A)、off(關閉) |
| referer_control.allow_empty | string | 是否允許空referer訪問 | 否 | 當referer_control.switch = on 時,必填 取值:on(開啟), off(關閉) |
| referer_control.type | int | 類型 | 否 | 當referer_control.switch = on 時,必填 取值:0(黑名單);1(白名單) |
| referer_control.list | list | referer列表 | 否 | 當referer_control.switch = on 時,必填 |
| https_switch | int | 開關 | 否 | 取值:0:關,1:開; |
| cert_name | str | 證書名 | 否 | 僅https_switch為1時生效 |
響應參數
| 參數 | 類型 | 說明 |
|---|---|---|
| code | int | 狀態碼,成功100000 |
| message | string | 描述信息,成功返回success,其他返回異常信息描述 |
示例
請求路徑://cdnapi-global.ctapi.daliqc.cn/live/domain/batch-update-configuration-information
請求示例
場景1:更新推流域名配置
{
"product_code": "005",
"domain": [
"daliqc.cn",
"daliqc.cn1",
"daliqc.cn2"
],
"ip_access_control": {
"switch": "on",
"list": [
"1.2.3.4",
"5.6.7.8"
],
"type": 1
},
"self_notice": {
"switch": "on",
"notify_address": "1.1.1.1",
"notify_host": "2.2.2.2",
"notify_port": 81,
"notify_start_url_path": "/pushStart",
"notify_stop_url_path": "/pushStop"
},
"time_shift": {
"switch": "on",
"max_playback_time": "32s",
"module_id": "d6aaaa5"
},
"third_push": {
"switch": "on",
"push_list": [
{
"origin": "1.1.1.1",
"host": "daliqc.cn3",
"port": "1935"
}
]
}
}
場景2:拉流域名配置修改(推拉流場景)
{
"product_code": "005",
"domain": [
"daliqc.cn",
"daliqc.cn1",
"daliqc.cn2"
],
"ip_access_control": {
"switch": "on",
"list": [
"1.2.3.4",
"5.6.7.8"
],
"type": 1
},
"referer_control": {
"switch": "on",
"list": [
"1.2.3.4",
"5.6.7.8"
],
"type": 1,
"allow_empty": "on"
},
"https_switch": 1,
"cert_name": "test0308"
}
場景3:拉流域名配置修改(回源拉流場景)
{
"product_code": "005",
"domain": [
"daliqc.cn",
"daliqc.cn1",
"daliqc.cn2"
],
"ip_access_control": {
"switch": "on",
"list": [
"1.2.3.4",
"5.6.7.8"
],
"type": 1
},
"referer_control": {
"switch": "on",
"list": [
"1.2.3.4",
"5.6.7.8"
],
"type": 1,
"allow_empty": "on"
},
"https_switch": 1,
"cert_name": "test0308"
}
正常響應示例
{
"code": 100000,
"message": "success",
"success_number": 3,
"domain_details": [
{
"code": 100000,
"message": "success",
"domain": "daliqc.cn"
},
{
"code": 100000,
"message": "success",
"domain": "daliqc.cn1"
},
{
"code": 100000,
"message": "success",
"domain": "daliqc.cn2"
}
]
}