接口功能介绍
调用本接口可查询视频直播产品指定域名配置信息
使用说明
- 单个用户一分钟限制调用10000次，并发不超过100
- 各功能默认为关闭，若无返回值，则代表关闭
接口详情
请求方式：POST
请求路径：/live/domain/query-domain-detail
请求参数
| 参数 | 类型 | 名称 | 是否必填 | 说明 |
|---|---|---|---|---|
| product_code | string | 产品类型 | 是 | 取值：“005”（即视频直播） |
| domain | string | 域名 | 是 | 支持单个域名 |
响应参数
| 参数 | 类型 | 名称 | 说明 |
|---|---|---|---|
| code | int | 状态码 | 成功100000 |
| message | string | 信息描述 | 成功返回success，其他返回异常信息描述 |
| domain | string | 域名 | |
| product_code | string | 产品类型 | |
| insert_date | string | 创建时间 | 毫秒 |
| status_date | string | 修改时间 | 毫秒 |
| status | int | 域名状态 | 4-已启用；6-已停止。域名详情只返回域名的确定状态，过程中的状态不会返回。 |
| area_scope | int | 服务区域 | 1-中国内地；2-全球（不含中国内地）； 3-全球 |
| conf_type | int | 域名配置类型 | 1（直播拉流）；2（直播推流） |
| pull_stream_mode | int | 拉流模式 | 取值：0：推拉流，1：回源拉流，默认取值为0 此参数只能在conf_type=1时起作用 |
| push_stream_domain | string | 关联推流域名 | |
| https_switch | int | 开关 | 取值：0：关，1：开；默认取值为0 |
| cert_name | string | 证书名 | 仅https_switch为1时生效 |
| rtmp_origin | list | rtmp协议回源参数 | 元素为字典 |
| rtmp_origin[*].origin | string | rtmp协议地址 | |
| flv_origin | list | flv协议http回源参数 | 元素为字典 |
| flv_origin[*].origin | string | flv协议地址 | |
| flv_https_origin | list | flv协议https回源参数 | 元素为字典 |
| flv_https_origin[*].origin | string | flv协议地址 | |
| hls_http_origin | list | hls协议回源参数 | 元素为字典 |
| hls_http_origin[*].origin | string | 源站 | |
| hls_https_origin | list | hls协议回源参数 | 元素为字典 |
| hls_https_origin[*].origin | string | 源站 | |
| distribution_protocol | string | 分发协议 | flv，rtmp，hls, 多个以逗号间隔 |
| ip_access_control | dict | ip黑白名单 | |
| ip_access_control.list | list | ip名单 | 示例：["1.1.1.1", "2.2.2.2"] |
| ip_access_control.type | int | 黑白名单 | 取值：0：黑名单，1：白名单；默认取值为0 |
| ip_access_control.switch | string | 开关 | 取值：on（开启）、off（关闭） |
| referer_control | dict | referfer黑白名单 | |
| referer_control.switch | string | 开关 | 取值：on（开启）、off（关闭） |
| referer_control.list | list | referfer名单 | 示例：["ctyun.cn","ctyun.cn1"] |
| referer_control.type | int | 黑白名单 | 取值：0：黑名单，1：白名单；默认取值为0 |
| referer_control.allow_empty | string | 空referfer | 取值"on", "off",取值"on", "off",默认"off" |
| self_notice | object | 推流回调 | 不传字段或者传值为null代表不做修改，否则默认整体替换 若self_notice.switch=off，本参数不会返回 |
| 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=off，本参数不会返回 |
| 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 | 转推 | 若third_push.switch，本参数不会返回 |
| third_push.switch | int | 转推开关，on（开启）、off（关闭） | |
| third_push.push_list | list | 转推列表 | |
| third_push.push_list[*].origin | string | 支持ipv4、ipv6和域名 | |
| third_push.push_list[*].port | string | 转推目标端口 默认1935 | 若转推目标端口为默认值为1935，不会返回 |
| third_push.push_list[*].host | string | 转推使用的请求头host |
示例
请求路径：https://cdnapi-global.ctapi.ctyun.cn/live/domain/query-domain-detail
请求示例
{
"product_code": "005",
"domain": "ctyun.cn"
}
正常响应示例
{
"code": 100000,
"message": "success",
"domain": "pull.ctyun.cn",
"product_code": "005",
"insert_date": "1657177732000",
"status": 4,
"area_scope": 1,
"conf_type": 1,
"pull_stream_mode": 0,
"push_stream_domain": "push.ctyun.cn",
"https_switch": 0,
"cert_name": "",
"rtmp_origin": [],
"flv_origin": [],
"flv_https_origin": [],
"hls_http_origin": [],
"hls_https_origin": [],
"distribution_protocol": "",
"ip_access_control": {
"type": 0,
"protocols": [],
"switch": "off"
},
"referer_control": {
"type": 0,
"allow_empty": "on",
"protocols": [],
"switch": "off"
},
"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": "d6aaaaaaa5"
},
"third_push": {
"switch": "on",
"push_list": [
{
"origin": "3.3.3.3",
"port": "1935",
"host": "ctyun.cn2"
}
]
}
}
错误码请参考：参数code和message含义
