直播服务接口

接口目录

创建频道

POST /channel/api/create

JSON 参数

参数 描述 取值
push_expiry 用户自定义推流过期时间戳（可选，默认10年） int
cdn_type 用户自定义 CDN（可选） string

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg 空字符串或错误信息 string
channel 频道信息 object
channel.created_datetime 创建时间 string
channel.updated_datetime 更新时间 string
channel.is_open 是否开启 bool
channel.live_status 是否正在直播 bool
channel.channel_id 频道 ID string
channel.rtmp_publish_addr 源推流地址 string
channel.cdn CDN 类型 string
channel.monitor_task_id 监控 ID string

返回示例：

{
    "errcode": 1000,
    "msg": "",
    "channel": {
        "created_datetime": "2010-11-22T15:16:17+08:00",
        "updated_datetime": "2010-11-22T15:16:17+08:00",
        "is_open": false,
        "live_status": false,
        "channel_id": "1",
        "rtmp_publish_addr": "1",
        "cdn": "1",
        "monitor_task_id": "1"
    }
}

获取一页频道信息

GET /channel/api/get_channellist

URL 参数

参数 描述 取值
page_number 页数，默认 1 int
page_size 每页个数，默认 10 int
is_open 频道是否开启 bool
live_status 是否正在直播 bool
cdn_type CDN 类型 string

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg 空字符串或错误信息 string
count 频道总个数 int
channel_list 频道列表 object array
channel_list.created_datetime 创建时间 string
channel_list.updated_datetime 更新时间 string
channel_list.is_open 是否开启 bool
channel_list.live_status 是否正在直播 bool
channel_list.channel_id 频道 ID string
channel_list.rtmp_publish_addr 源推流地址 string
channel_list.cdn CDN 类型 string
channel_list.cover_url 封面 URL string
channel_list.key_frame_image_storage_id 关键帧封面 URL string
channel_list.realtime_screenshot 该频道的实时截图配置 bool
channel_list.monitor_task_id 监控 ID string
channel_list.push_expiry 推流过期时间 int
channel_list.play_expiry 拉流过期时间 int
channel_list.shared_state 分享状态（0-私有，1-需要密码，2-不需要密码） int
channel_list.share_password 频道分享密码 string
channel.is_record 是否录制 bool
channel.is_timeshift 是否时移 bool

返回示例：

{
    "errcode": 1000,
    "msg": "",
    "count": 33,
    "channel_list": [
        {
            "created_datetime": "2010-11-22T15:16:17+08:00",
            "updated_datetime": "2010-11-22T15:16:17+08:00",
            "is_open": false,
            "live_status": false,
            "channel_id": "1",
            "rtmp_publish_addr": "1",
            "cdn": "1",
            "monitor_task_id": "1"
        }
    ]
}

获取频道信息

GET /channel/api/get_channel

URL 参数

参数 描述 取值
channel 频道 ID string

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg 空字符串或错误信息 string
channel 频道信息 object
channel.created_datetime 创建时间 string
channel.updated_datetime 更新时间 string
channel.is_open 是否开启 bool
channel.live_status 是否正在直播 bool
channel.channel_id 频道 ID string
channel.rtmp_publish_addr 源推流地址 string
channel.cdn CDN 类型 string
channel.cover_url 封面 URL string
channel.key_frame_image_storage_id 关键帧封面 URL string
channel_list.realtime_screenshot 该频道的实时截图配置 bool
channel.monitor_task_id 监控 ID string
channel.push_expiry 推流过期时间 int
channel.play_expiry 拉流过期时间 int
channel.shared_state 分享状态（0-私有，1-需要密码，2-不需要密码） int
channel.share_password 频道分享密码 string
channel.is_record 是否录制 bool
channel.is_timeshift 是否时移 bool
channel.play_sets 拉流地址列表 object array
channel.play_sets.region 地区 string
channel.play_sets.test_addr 测试地址 string
channel.play_sets.protocol 协议类型 string
channel.play_sets.resolution 清晰度 string
channel.play_sets.address 播放地址 string
channel.distributions 频道分发区域列表 object array
channel.distributions.distribution_id 分发 ID string
channel.distributions.status 状态(0-关闭，1-开启，2-申请中，3-未申请) int
channel.distributions.region 海外节点名称英文简写（如 SG JP 等） string
channel.distributions.region_name 海外节点名称中文描述 string
channel.distributions.cdn_type 该海外节点所使用的 CDN string
channel.distributions.server_ip 企业内网地址 string
channel.distributions.push_url 该海外节点的推流地址 string
channel.distributions.play_sets 该海外节点的播放地址列表 object array
channel.distributions.play_sets.protocol 协议类型 string
channel.distributions.play_sets.address 播放地址 string

返回示例：

{
    "errcode": 1000,
    "msg": "",
    "channel": {
        "created_datetime": "2010-11-22T15:16:17+08:00",
        "updated_datetime": "2010-11-22T15:16:17+08:00",
        "is_open": false,
        "live_status": false,
        "channel_id": "1",
        "rtmp_publish_addr": "1",
        "cdn": "1",
        "monitor_task_id": "1"
    }
}

获取分享频道信息

GET /channel/api/get_shared_channel

若访问该频道需要密码，当密码一致时才能获取该频道

URL 参数

参数 描述 取值
channel 频道 ID string
password 频道密码 string

返回内容同获取频道信息

设置频道分享密码

POST /channel/api/set_channel_password

URL 参数

参数 描述 取值
channel 频道 ID string

JSON 参数

参数 描述 取值
shared_state 分享状态（0-私有，1-需要密码，2-不需要密码） int
password 频道分享密码（0-16位字符） string

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg "OK" 或错误信息 string

返回示例：

{
    "errcode": 1000,
    "msg": "OK"
}

删除频道

POST /channel/api/delete

URL 参数

参数 描述 取值
channel 频道 ID string

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg 空字符串或错误信息 string

返回示例：

{
    "errcode": 1000,
    "msg": ""
}

批量删除频道

POST /channel/api/delete_channels

URL 参数

参数 描述 取值
channels 一组频道 ID，用逗号隔开 string

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg 空字符串或错误信息 string

返回示例：

{
    "errcode": 1000,
    "msg": ""
}

开启、关闭直播频道

POST /channel/api/modifystatus

URL 参数

参数 描述 取值
channel 频道 ID string

JSON 参数

参数 描述 取值
is_open 是否开启 bool

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg 空字符串或错误信息 string

返回示例：

{
    "errcode": 1000,
    "msg": ""
}

修改频道推流过期时间、观看过期时间

POST /channel/api/modify_expiry

URL 参数

参数 描述 取值
channel 频道 ID string

JSON 参数

参数 描述 取值
push_expiry 用户自定义推流过期时间戳 int
play_expiry 用户自定义拉流过期时间戳 int

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg 空字符串或错误信息 string

返回示例：

{
    "errcode": 1000,
    "msg": ""
}

设置用户CDN

POST /channel/api/setcdn

支持的 CDN

  • myun
  • new-myun
  • aliyun
  • baiduyun
  • huawei
  • huawei3

JSON 参数

参数 描述 取值
cdn CDN 类型 string

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg 空字符串或错误信息 string

返回示例：

{
    "errcode": 1000,
    "msg": ""
}

获取用户CDN

GET /channel/api/cdn

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg 空字符串或错误信息 string
cdn 用户 CDN 配置 object
cdn.CreatedDatetime 创建时间 string
cdn.Cdn CDN 类型 string

返回示例：

{
    "errcode": 1000,
    "msg": "",
    "cdn": {
        "CreatedDatetime": "2010-11-22T15:16:17+08:00",
        "Cdn": "1"
    }
}

获取播放地址

GET /channel/api/play_set

URL 参数

参数 描述 取值
channel 直播频道 ID string
play_expiry 播放地址过期时间戳，当该值大于当前时间戳才生效，否则使用该直播频道本身的过期时间戳 int

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg 空字符串或错误信息 string
videoaddr 拉流地址 object array
videoaddr.region 地区 string
videoaddr.test_addr 测试地址 string
videoaddr.protocol 协议类型 string
videoaddr.resolution 清晰度 string
videoaddr.address 播放地址 string

返回示例：

{
    "errcode": 1000,
    "msg": "",
    "videoaddr": [
        {
            "region": "1",
            "test_addr": "1",
            "protocol": "1",
            "resolution": "1",
            "address": "1"
        }
    ]
}

设置用户转码配置

POST /channel/api/set_user_transcfg

JSON 参数

参数 描述 取值
ld 流畅 bool
sd 标清 bool
hd 高清 bool
fhd 全高清 bool
audio_only 仅音频 bool

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg 空字符串或错误信息 string

返回示例：

{
    "errcode": 1000,
    "msg": ""
}

获取用户转码配置

GET /channel/api/get_user_transcfg

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg 空字符串或错误信息 string
cfg 用户转码配置 object
cfg.ld 流畅 bool
cfg.sd 标清 bool
cfg.hd 高清 bool
cfg.fhd 全高清 bool
cfg.audio_only 仅音频 bool

返回示例：

{
    "errcode": 1000,
    "msg": "",
    "cfg": {
        "ld": false,
        "sd": false,
        "hd": false,
        "fhd": false,
        "audio_only": true
    }
}

删除用户转码配置

POST /channel/api/del_user_transcfg

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg 空字符串或错误信息 string

返回示例：

{
    "errcode": 1000,
    "msg": ""
}

设置频道转码配置

POST /channel/api/set_channel_transcfg

URL 参数

参数 描述 取值
channel 频道 ID string

JSON 参数

参数 描述 取值
ld 流畅 bool
sd 标清 bool
hd 高清 bool
fhd 全高清 bool
audio_only 仅音频 bool

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg 空字符串或错误信息 string

返回示例：

{
    "errcode": 1000,
    "msg": ""
}

获取频道转码配置

GET /channel/api/get_channel_transcfg

URL 参数

参数 描述 取值
channel 频道 ID string

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg 空字符串或错误信息 string
cfg 频道转码配置 object
cfg.ld 流畅 bool
cfg.sd 标清 bool
cfg.hd 高清 bool
cfg.fhd 全高清 bool
cfg.audio_only 仅音频 bool

返回示例：

{
    "errcode": 1000,
    "msg": "",
    "cfg": {
        "ld": false,
        "sd": false,
        "hd": false,
        "fhd": false,
        "audio_only": true
    }
}

删除频道转码配置

POST /channel/api/del_channel_transcfg

URL 参数

参数 描述 取值
channel 频道 ID string

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg 空字符串或错误信息 string

返回示例：

{
    "errcode": 1000,
    "msg": ""
}

设置频道CDN

POST /channel/api/set_channel_cdn

优先使用频道 CDN，若未配置则使用用户 CDN

修改完成后返回新的推流地址

URL 参数

参数 描述 取值
channel 频道 ID string

JSON 参数

参数 描述 取值
cdn CDN 类型 string

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg 空字符串或错误信息 string
channel 频道信息 object
channel.rtmp_publish_addr 源推流地址 string

返回示例：

{
    "errcode": 1000,
    "msg": "",
    "channel": {
        "rtmp_publish_addr": "rtmp://example.com/live/1.m3u8"
    }
}

设置频道封面

POST /channel/api/set_channel_cover

URL 参数

参数 描述 取值
channel 频道 ID string

JSON 参数

参数 描述 取值
cover_storage_id 存储 ID string

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg 空字符串或错误信息 string

返回示例：

{
    "errcode": 1000,
    "msg": ""
}

设置用户实时截图配置

POST /channel/api/set_user_screenshot_config

JSON 参数

参数 描述 取值
realtime_screenshot 全局配置，是否在直播时开启实时截图 bool

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg 空字符串或错误信息 string

返回示例：

{
    "errcode": 1000,
    "msg": ""
}

获取用户实时截图配置

GET /channel/api/get_user_screenshot_config

返回字段

参数 描述 取值
config 用户实时截图配置 object
config.realtime_screenshot 是否在该频道直播时开启实时截图 bool
errcode 错误码，1000 为正常 int
msg 空字符串或错误信息 string

返回示例：

{
    "config": {
        "realtime_screenshot": true
    },
    "errcode": 1000,
    "msg": ""
}

设置频道实时截图配置

POST /channel/api/set_channel_screenshot_config

URL 参数

参数 描述 取值
channel 频道 ID string

JSON 参数

参数 描述 取值
realtime_screenshot 是否在该频道直播时开启实时截图 bool

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg 空字符串或错误信息 string

返回示例：

{
    "errcode": 1000,
    "msg": ""
}

获取频道实时截图配置

GET /channel/api/get_channel_screenshot_config

返回字段

参数 描述 取值
config 用户实时截图配置 object
config.realtime_screenshot 是否在该频道直播时开启实时截图 bool
errcode 错误码，1000 为正常 int
msg 空字符串或错误信息 string

返回示例：

{
    "config": {
        "realtime_screenshot": true
    },
    "errcode": 1000,
    "msg": ""
}

删除频道实时截图配置

POST /channel/api/del_channel_screenshot_config

URL 参数

参数 描述 取值
channel 频道 ID string

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg 空字符串或错误信息 string

返回示例：

{
    "errcode": 1000,
    "msg": ""
}

获取直播历史记录（含流量数据）

GET /channel/api/list_streaming_records

可以选择如下查询方式：

  • 按频道 ID 查询（返回结果无时间限制）
  • 按直播开始时间查询，即 start<=直播开始时间<=end，且 end-start<=90天

URL 参数

参数 描述 取值
channel 频道 ID string
start 时间戳 int
end 时间戳 int
page 页数，默认 1 int
page_size 每页个数，默认 20 int
order 按时间顺序正序或倒序查询，正序为 asc，倒序为 desc，默认为 asc string

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg "OK" 或错误信息 string
count 满足查询条件的直播记录总数 int
streaming_records 结果列表 object array
streaming_records.started_at 直播开始时间 string
streaming_records.ended_at 直播结束时间 string
streaming_records.monitor_task_id 监控任务ID string
streaming_records.total_bytes 使用流量（字节） int
streaming_records.peak_bandwidth 峰值带宽 int
streaming_records.peak_bandwidth_time 峰值带宽发生时间 string

获取频道监控数据

GET /channel/api/get_channel_monitordata

URL 参数

参数 描述 取值
page_number 页数，默认 1 int
page_size 每页个数，默认 10 int
channel 频道 ID string
after 返回此时间戳之后的数据，单位为秒，默认为0 int
order 数据按时间顺序排序，正序为asc，倒序为desc，默认desc string

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg 空字符串或错误信息 string
count 监控数据总数 int
monitor_data 监控数据 object array
monitor_data.empty 取空的次数 int
monitor_data.sum 取帧的次数 int
monitor_data.fps 视频帧率 float
monitor_data.kbpsv 视频比特率 int
monitor_data.kbpsa 音频比特率 int
monitor_data.time 回调时间 string

返回示例：

{
    "errcode": 1000,
    "msg": "",
    "count": 33,
    "monitor_data": [
        {
            "empty": 1,
            "sum": 1,
            "fps": 1,
            "kbpsv": 1,
            "kbpsa": 1,
            "time": "1"
        }
    ]
}

添加WebVTT翻页事件

POST /channel/api/add_webvtt_event

JSON 参数

参数 描述 取值
app 应用名（可选，默认为live） string
stream 直播 ID string
content 字幕内容 string

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg 空字符串或错误信息 string

返回示例：

{
    "errcode": 1000,
    "msg": ""
}

获取时间段内的WebVTT片段

GET /channel/api/webvtt

时间戳精确到毫秒 返回 WebVTT 文件(流)

URL 参数

参数 描述 取值
app 应用名 string
stream 直播 ID string
MPEGTS 码率 int
timestamp 片段时间戳，精确到毫秒 int
duration 片段长度（秒） int

返回内容

  • 无字幕
WEBVTT
X-TIMESTAMP-MAP=LOCAL:00:00:00.000,MPEGTS:90000
  • 有字幕
WEBVTT
X-TIMESTAMP-MAP=LOCAL:00:00:00.000,MPEGTS:90000
1
00:00:00.000 --> 00:00:01.000
ppt1.jpg
2
00:00:02.000 --> 00:00:03.000
ppt2.jpg

添加点播视频解析WebVTT任务

POST /channel/api/add_sei_task

JSON 参数

参数 描述 取值
source_url 点播视频地址，必须是转码后的，暂时只支持目睹云线路直播后的录制或者拆条视频 string

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg 空字符串或错误信息 string
sei_task_id 点播视频解析WebVTT任务的任务id string

返回示例：

{
    "errcode": 1000,
    "msg": "",
    "sei_task_id": "xxx"
}

通知notify:

当任务成功完成或者失败时，直播会发送一个通知，通知有以下字段

参数 描述 取值
event_type 通知事件类型, 用来和其他通知区分开来, 值为sei_task_done string
sei_task_id 点播视频解析WebVTT任务的任务id string
success 是否成功 bool
errmsg 如果失败，失败的信息 string

获取点播视频解析WebVTT任务

GET /channel/api/get_sei_task

URL 参数

参数 描述 取值
sei_task_id 点播视频解析WebVTT任务的任务id string

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg 空字符串或错误信息 string
sei_task 点播视频解析WebVTT任务 object
sei_task.status 任务状态，0为进行中, 1为完成, 2为失败 int
sei_task.source_url 解析的点播视频地址 string
sei_task.created_at 任务创建时间 string
sei_task.updated_at 任务更新时间 string

返回示例:

{
    "errcode": 1000,
    "msg": "",
    "sei_task": {
        "status": 1,
        "source_url": "https://devobs.myun.tv/ob026851/a5k299a5/d5v8dgnl/e54z64kl_1554901567785632956_360p.m3u8",
        "created_at": "2019-04-16T09:48:46+08:00",
        "updated_at": "2019-04-16T09:48:51+08:00"
    }
}

删除点播视频解析WebVTT任务

POST /channel/api/del_sei_task

URL 参数

参数 描述 取值
sei_task_id 点播视频解析WebVTT任务的任务id string

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg 空字符串或错误信息 string

返回示例：

{
    "errcode": 1000,
    "msg": ""
}

获取点播视频解析WebVTT任务结果

GET /channel/api/list_sei_task_result

URL 参数

参数 描述 取值
sei_task_id 点播视频解析WebVTT任务的任务id string
page_number 页码，可选，默认为1 int
page_size 每页数量，可选，默认为10 int

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg 空字符串或错误信息 string
total 总共有多少条WebVtt信息 int
sei_task_result 取到的结果，是一个列表，里面的每一条信息对应着调用/channel/api/add_webvtt_event添加的信息 array
sei_task_result[index].stream 直播id string
sei_task_result[index].content webvtt_event内容 string
sei_task_result[index].absolute_time 从格林威治时间1970年01月01日00时00分00秒到调用/channel/api/add_webvtt_event添加信息时的毫秒数 int
sei_task_result[index].relative_time 相对时间，相对于点播视频开始时的时间，单位为毫秒 int

列出某个频道的每分钟流量

GET /channel/api/list_streaming_statistic

可以查询跨度在90天内的该频道的流量数据，即查询该频道的 [start, end] 时间范围内的每分钟流量，且 end-start<=90天

由于统计有延迟，某个分钟产生的流量会在 6-8 小时后统计出来。

URL 参数

参数 描述 取值
channel 频道 ID string
start 时间戳 int
end 时间戳 int

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg "OK" 或错误信息 string
streaming_statistic_list 结果列表 object array
streaming_statistic_list.time 分钟 string
streaming_statistic_list.bytes 使用流量（字节） int

列出该用户创建的所有频道的每分钟的流量之和（某一时间范围内的）

GET /channel/api/list_user_streaming_statistic

可以查询跨度在90天内的流量数据，即 end-start<=90天

URL 参数

参数 描述 取值
start 时间戳 int
end 时间戳 int

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg "OK" 或错误信息 string
streaming_statistic_list 结果列表 object array
streaming_statistic_list.time 分钟 string
streaming_statistic_list.total_bytes 使用流量（字节） int

导出该用户创建的所有频道的每日的流量之和，一天一条数据

GET /channel/api/export_user_streaming_day_summary

可以查询跨度在90天内的每日流量数据，即 end-start<=90天

URL 参数

参数 描述 取值
start 时间戳 int
end 时间戳 int

返回一个 CSV 文件

导出单次直播流量数据，按照频道ID或直播开始时间查询

GET /channel/api/export_streaming_records

可以选择如下查询方式：

  • 按频道 ID 查询（返回结果无时间限制）
  • 按直播开始时间查询，即 start<=直播开始时间<=end，且 end-start<=90天

URL 参数

参数 描述 取值
channel 频道 ID string
start 时间戳 int
end 时间戳 int

返回一个 CSV 文件

分页获取频道数据，按照频道创建时间或频道ID查询

GET /channel/api/list_streaming_total_summary

可以选择如下查询方式：

  • 按频道 ID 查询（返回结果无时间限制）
  • 按频道创建时间查询，即 start<=频道创建时间<=end，且 end-start<=90天

URL 参数

参数 描述 取值
channel 频道 ID string
start 时间戳 int
end 时间戳 int
page 页数，默认 1 int
page_size 每页个数，默认 20 int

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg "OK" 或错误信息 string
count 满足查询条件的频道总数 int
streaming_total_summary_list 结果列表 object array
streaming_total_summary_list.channel_created_at 频道创建时间 string
streaming_total_summary_list.total_bytes 使用流量（字节） int
streaming_total_summary_list.peak_bandwidth 峰值带宽 int
streaming_total_summary_list.peak_bandwidth_time 峰值带宽发生时间 string

导出频道数据，按照频道创建时间或频道ID查询

GET /channel/api/export_streaming_total_summary

可以选择如下查询方式：

  • 按频道 ID 查询（返回结果无时间限制）
  • 按频道创建时间查询，即 start<=频道创建时间<=end，且 end-start<=90天

URL 参数

参数 描述 取值
channel 频道 ID string
start 时间戳 int
end 时间戳 int

返回一个 CSV 文件

获取该用户创建的所有频道的总流量之和

GET /channel/api/get_user_streaming_total_summary

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg "OK" 或错误信息 string
user_streaming_total_summary 结果对象 object
user_streaming_total_summary.total_bytes 使用流量（字节） int
user_streaming_total_summary.peak_bandwidth 峰值带宽 int
user_streaming_total_summary.peak_bandwidth_time 峰值带宽发生时间 string

申请CDN

POST /channel/api/create_cdn_application

JSON 参数

参数 描述 取值
cdn_type 申请的 CDN 类型 string
purpose 申请的 CDN 的用途 string

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg "OK" 或错误信息 string

返回示例：

{
    "errcode": 1000,
    "msg": "OK"
}

获取可用的CDN列表

GET /channel/api/get_available_cdn_list

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg "OK" 或错误信息 string
cdn_list 可用 CDN 数组 string array

返回示例：

{
    "errcode": 1000,
    "msg": "OK",
    "cdn_list": ["aliyun", "custom-cdn"]
}

申请专线ECDN

POST /channel/api/create_ecdn_application

URL 参数

参数 描述 取值
channel 频道 ID string

JSON 参数

参数 描述 取值
application_type 申请类型，0为默认专线，1为企业内网 int
region 申请的节点名称缩写（SG AU custom 等，企业内网填 custom） string
region_name 申请的节点名称（企业内网需要） string
cdn_type 申请的 CDN 类型 string
server_ip 服务器地址（企业内网需要） string
purpose 申请用途 string

返回字段

参数 描述 取值
distribution_id 分发 ID string
errcode 错误码，1000 为正常 int
msg "OK" 或错误信息 string

返回示例：

{
    "distribution_id": "gb26p1an",
    "errcode": 1000,
    "msg": "OK"
}

取消申请专线ECDN

POST /channel/api/cancel_ecdn_application

URL 参数

参数 描述 取值
channel 频道 ID string
distribution_id 分发 ID string

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg "OK" 或错误信息 string

返回示例：

{
    "errcode": 1000,
    "msg": "OK"
}

开启/关闭已通过的ECDN

POST /channel/api/modify_ecdn_status

URL 参数

参数 描述 取值
channel 频道 ID string
distribution_id 分发 ID string

JSON 参数

参数 描述 取值
status 0-关闭，1-开启(其他的均返回参数错误) int

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg "OK" 或错误信息 string

返回示例：

{
    "errcode": 1000,
    "msg": "OK"
}

开启/关闭直播录制

POST /channel/api/set_channel_record

URL 参数

参数 描述 取值
channel 频道 ID string

JSON 参数

参数 描述 取值
is_record false-关闭，true-开启 bool

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg "OK" 或错误信息 string

返回示例：

{
    "errcode": 1000,
    "msg": "OK"
}

开启/关闭直播时移

POST /channel/api/set_channel_timeshift

URL 参数

参数 描述 取值
channel 频道 ID string

JSON 参数

参数 描述 取值
is_timeshift false-关闭，true-开启 bool

返回字段

参数 描述 取值
errcode 错误码，1000 为正常 int
msg "OK" 或错误信息 string

返回示例：

{
    "errcode": 1000,
    "msg": "OK"
}

results matching ""

    No results matching ""