文档首页/ 视频直播 Live/ 媒体直播API参考/ OTT频道管理/ 修改频道打包信息 - ModifyOttChannelInfoEndPoints
更新时间:2025-12-11 GMT+08:00
分享

修改频道打包信息 - ModifyOttChannelInfoEndPoints

功能介绍

修改频道打包信息。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

授权信息

账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

live:ott:updateChannelEndpoint

Write

-

-

-

-

URI

PUT /v1/{project_id}/ott/channels/endpoints

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,使用Token鉴权方式时为必填项。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Authorization

String

使用AK/SK方式认证时必填,携带的鉴权信息。

X-Sdk-Date

String

请求的发生时间,使用AK/SK方式认证时为必填项。

X-Project-Id

String

使用AK/SK方式认证时为必填项,携带项目ID信息。

表3 请求Body参数

参数

是否必选

参数类型

描述

domain

String

参数解释:

频道推流域名

约束限制:

不涉及

取值范围:

只能由小写英文字符与"-"、"_"组成,且长度为[1~255]个字符。

默认取值:

不涉及

app_name

String

参数解释:

组名或应用名

约束限制:

不涉及

取值范围:

只能由英文字符与"-"、"_"组成,首字符必须为字母。且长度为[1~64]个字符。

默认取值:

不涉及

id

String

参数解释:

频道ID,频道唯一标识。

约束限制:

不涉及

取值范围:

只能由英文字符与"-"、"_"组成,首字符必须为字母。且长度为[2~64]个字符。

默认取值:

不涉及

endpoints

Array of EndpointItem objects

频道出流信息

表4 EndpointItem

参数

是否必选

参数类型

描述

hls_package

Array of HlsPackageItem objects

HLS打包信息

dash_package

Array of DashPackageItem objects

DASH打包信息

mss_package

Array of MssPackageItem objects

MSS打包信息

表5 HlsPackageItem

参数

是否必选

参数类型

描述

id

String

参数解释:

package唯一标识id,由服务创建并在查询时返回,修改endpoints时需要携带。

约束限制:

不涉及

取值范围:

只能由英文字符组成,且长度为[0~32]个字符。

默认取值:

不涉及

url

String

参数解释:

客户自定义的拉流地址

约束限制:

不涉及

取值范围:

只能由英文字符组成,且长度为[0~1024]个字符。

默认取值:

不涉及

stream_selection

Array of StreamSelectionItem objects

从全量流中过滤出一个码率在[min, max]区间的流。如果不需要码率过滤可不选。

hls_version

String

参数解释:

HLS版本号

约束限制:

不涉及

取值范围:

长度为[0~10]个字符。

默认取值:

不涉及

segment_duration_seconds

Integer

参数解释:

频道输出分片的时长,为必选项,单位:秒。

修改分片时长会影响已录制内容的时移和回看服务,请谨慎修改!

约束限制:

不涉及

默认取值:

不涉及

playlist_window_seconds

Integer

参数解释:

频道直播返回分片的窗口长度,为频道输出分片的时长乘以数量后得到的值。实际返回的分片数不小于3个。单位:秒。

约束限制:

不涉及

默认取值:

不涉及

encryption

Encryption object

加密信息

ads

Object

参数解释:

广告配置

约束限制:

不涉及

ext_args

Object

参数解释:

其他额外参数

约束限制:

不涉及

request_args

PackageRequestArgs object

播放相关配置

ad_marker

Array of strings

参数解释:

广告标识。

约束限制:

不能超过10条。HLS取值:["ENHANCED_SCTE35"]。

enable_access

Boolean

参数解释:

允许本输出可以直接从源站拉流

约束限制:

频道类型mode是ONLY_OS类型

取值范围:

  • true:允许output访问

  • false:禁止output访问

默认取值:

false

allow_all_ip_access

Boolean

参数解释:

是否放通所有的IP访问

约束限制:

频道类型mode是ONLY_OS类型

取值范围:

  • true:允许所有的IP地址访问,ip_whitelist配置不生效

  • false:不允许所有的IP地址访问,ip_whitelist生效,仅在ip_whitelist配置的ip地址才能访问

默认取值:

false

ip_whitelist

String

参数解释:

允许直接从源站拉流的IP白名单

约束限制:

频道类型mode是ONLY_OS类型

取值范围:

长度限制[0~2048]

默认取值:

不涉及

cdn_identifier_header

HttpHeader object

参数解释:

HttpHeader CDN认证头域

origin_domain_master

String

参数解释:

源站分发域名-主region

约束限制:

domain.region跟CreateOttChannelInfoReq.region一致

满足正则:^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?.){2,}[a-zA-Z]{2,16}$

取值范围:

长度限制[0~255]

默认取值:

不涉及

origin_domain_slave

String

参数解释:

源站分发域名-备region

约束限制:

origin_domain_master的备源站

1、国际站

新加坡的备源站:香港

香港的备源站:新加坡

利雅得的备源站:新加坡

约翰内斯堡的备源站:新加坡

2、中国站

北京四的备源站:上海

满足正则:^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?.){2,}[a-zA-Z]{2,16}$

取值范围:

长度限制[0~255]

默认取值:

不涉及

manifest_name

String

参数解释:

output的索引文件名字

约束限制:

频道类型mode是ONLY_OS类型

取值范围:

大小写字母、数字、"-"、"."、"_",不能有/路径,且长度限制[0~128]

默认取值:

index

slave_url

String

参数解释:

备region拉流地址,无需配置,由服务生成。

约束限制:

频道类型mode是ONLY_OS类型

取值范围:

长度限制[0~1024]

默认取值:

不涉及

manifest_selection

ManifestSelection object

参数解释:

流选择配置

约束限制:

不涉及

表6 DashPackageItem

参数

是否必选

参数类型

描述

id

String

package唯一标识id,由服务创建并在查询时返回,修改endpoints时需要携带。

url

String

客户自定义的拉流地址,包括方法、域名、路径

stream_selection

Array of StreamSelectionItem objects

从全量流中过滤出一个码率在[min, max]区间的流。如果不需要码率过滤可不选。

segment_duration_seconds

Integer

频道输出分片的时长,为必选项

单位:秒。取值范围:1-10

说明:
修改分片时长会影响已录制内容的时移和回看服务,请谨慎修改!

playlist_window_seconds

Integer

频道直播返回分片的窗口长度,为频道输出分片的时长乘以数量后得到的值。实际返回的分片数不小于3个。

单位:秒。取值范围:0 - 86400(24小时转化成秒后的取值)

encryption

Encryption object

加密信息

ads

Object

广告配置

ext_args

Object

其他额外参数

request_args

PackageRequestArgs object

播放相关配置

ad_marker

String

广告标识。

DASH取值:"xml+bin"。

suggested_presentation_delay

Integer

建议播放延迟

单位:秒。取值范围:[1 - 120]

minimum_update_period

Integer

索引最短更新周期

单位:秒。取值范围:[1 - 120]

min_buffer_time

Integer

最小缓冲时间

单位:秒。取值范围:[1 - 120]

enable_access

Boolean

默认:false

true:允许output访问

false:禁止output访问

allow_all_ip_access

Boolean

是否放通所有的IP访问,默认:false

true:允许所有的IP地址访问,ip_whitelist配置不生效

false:不允许所有的IP地址访问,ip_whitelist生效,仅在ip_whitelist配置的ip地址才能访问

ip_whitelist

String

当allow_all_ip_access为false时生效

允许访问的ip地址,规则是CIDR,可以配置多个用,隔开

cdn_identifier_header

HttpHeader object

HttpHeader CDN认证头域

origin_domain_master

String

源站分发域名-主region

跟CreateOttChannelInfoReq.region一致

满足正则:^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?.){2,}[a-zA-Z]{2,16}$

最大长度255

origin_domain_slave

String

源站分发域名-备region

约束:

1、国际站

新加坡的备源站:香港

香港的备源站:新加坡

利雅得的备源站:新加坡

约翰内斯堡的备源站:新加坡

2、中国站

北京四的备源站:上海

满足正则:^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?.){2,}[a-zA-Z]{2,16}$

最大长度255

manifest_name

String

output的索引文件名字

默认:index

长度:0-128

字符集:大小写字母、数字、"-"、"."、"_",不能有/路径

slave_url

String

客户自定义的拉流地址,包括方法、域名、路径

manifest_selection

ManifestSelection object

参数解释:

流选择配置

约束限制:

不涉及

表7 MssPackageItem

参数

是否必选

参数类型

描述

id

String

package唯一标识id,由服务创建并在查询时返回,修改endpoints时需要携带。

url

String

客户自定义的拉流地址,包括方法、域名、路径

stream_selection

Array of StreamSelectionItem objects

从全量流中过滤出一个码率在[min, max]区间的流。如果不需要码率过滤可不选。

segment_duration_seconds

Integer

频道输出分片的时长,为必选项

单位:秒。取值范围:1-10

说明:
修改分片时长会影响已录制内容的时移和回看服务,请谨慎修改!

playlist_window_seconds

Integer

频道直播返回分片的窗口长度,为频道输出分片的时长乘以数量后得到的值。实际返回的分片数不小于3个。

单位:秒。取值范围:0 - 86400(24小时转化成秒后的取值)

encryption

Encryption object

加密信息

ext_args

Object

其他额外参数

delay_segment

Integer

延播时长,单位秒

request_args

PackageRequestArgs object

播放相关配置

enable_access

Boolean

默认:false

true:允许output访问

false:禁止output访问

allow_all_ip_access

Boolean

是否放通所有的IP访问,默认:false

true:允许所有的IP地址访问,ip_whitelist配置不生效

false:不允许所有的IP地址访问,ip_whitelist生效,仅在ip_whitelist配置的ip地址才能访问

ip_whitelist

String

当allow_all_ip_access为false时生效

允许访问的ip地址,规则是CIDR,可以配置多个用,隔开

cdn_identifier_header

HttpHeader object

HttpHeader,CDN认证头域

origin_domain_master

String

源站分发域名-主region

跟CreateOttChannelInfoReq.region一致

满足正则:^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?.){2,}[a-zA-Z]{2,16}$

最大长度255

origin_domain_slave

String

源站分发域名-备region

约束:

1、国际站

新加坡的备源站:香港

香港的备源站:新加坡

利雅得的备源站:新加坡

约翰内斯堡的备源站:新加坡

2、中国站

北京四的备源站:上海

满足正则:^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?.){2,}[a-zA-Z]{2,16}$

最大长度255

manifest_name

String

output的索引文件名字

默认:index

长度:0-128

字符集:大小写字母、数字、"-"、"."、"_",不能有/路径

slave_url

String

客户自定义的拉流地址,包括方法、域名、路径

manifest_selection

ManifestSelection object

参数解释:

流选择配置

约束限制:

不涉及

表8 StreamSelectionItem

参数

是否必选

参数类型

描述

key

String

拉流URL中用于码率过滤的参数

max_bandwidth

Integer

最大码率,单位:bps

取值范围:0 - 104,857,600(100Mbps)

min_bandwidth

Integer

最小码率,单位:bps

取值范围:0 - 104,857,600(100Mbps)

表9 Encryption

参数

是否必选

参数类型

描述

key_rotation_interval_seconds

Integer

参数解释:

密钥缓存时间。如果密钥不变,默认缓存七天。

约束限制:

目前为保留字段,不支持配置。

默认取值:

不涉及

encryption_method

String

参数解释:

加密方式。

约束限制:

目前为保留字段,不支持配置。

取值范围:

  • SAMPLE-AES

  • AES-128

默认取值:

SAMPLE-AES

level

String

参数解释:

加密等级。

约束限制:

不涉及

取值范围:

  • content:一个频道对应一个密钥

  • profile:一个码率对应一个密钥

默认取值:

content

resource_id

String

参数解释:

客户生成的DRM内容ID。

约束限制:

不涉及

取值范围:

支持英文字符与“-”、“_”,且长度限制[1~128]个字符

默认取值:

不涉及

system_ids

Array of strings

参数解释:

system_id枚举值。

取值范围:

取值如下:

  • HLS:FairPlay

  • DASH:Widevine、PlayReady

  • MSS:PlayReady

url

String

参数解释:

获取密钥的DRM地址

约束限制:

不涉及

取值范围:

长度限制[1~2048]个字符

默认取值:

不涉及

speke_version

String

参数解释:

drm speke 版本号 当前只支持1.0

取值范围:

  • '1.0'

默认取值:

不涉及

request_mode

String

参数解释:

请求模式。

取值范围:

  • direct_http:HTTP(S)直接访问DRM。

  • functiongraph_proxy:FunctionGraph代理访问DRM。

默认取值:

不涉及

http_headers

Array of HttpHeader objects

参数解释:

需要添加在drm请求头中的鉴权信息。

约束限制:

仅direct_http请求模式支持配置http_headers。最多支持配置5个。

urn

String

参数解释:

functiongraph_proxy请求模式需要提供functiongraph的urn。

约束限制:

不涉及

取值范围:

长度限制[1~512]个字符

默认取值:

不涉及

表10 HttpHeader

参数

是否必选

参数类型

描述

key

String

请求头中key字段名

value

String

请求头中key对应的value值

表11 PackageRequestArgs

参数

是否必选

参数类型

描述

record

Array of RecordRequestArgs objects

录制播放相关配置

timeshift

Array of TimeshiftRequestArgs objects

时移播放相关配置

live

Array of LiveRequestArgs objects

直播播放相关配置

表12 RecordRequestArgs

参数

是否必选

参数类型

描述

start_time

String

开始时间

end_time

String

结束时间

format

String

格式

unit

String

单位

表13 TimeshiftRequestArgs

参数

是否必选

参数类型

描述

back_time

String

时移时长字段名

unit

String

单位

表14 LiveRequestArgs

参数

是否必选

参数类型

描述

delay

String

时延字段

unit

String

单位

表15 ManifestSelection

参数

是否必选

参数类型

描述

stream_order

String

参数解释:

流排序模式

约束限制:

不涉及

取值范围:

ORIGINAL:保持原始顺序,即按照频道配置中转码模板的顺序

VIDEO_BITRATE_ASCENDING:按照视频码率升序

VIDEO_BITRATE_DESCENDING:按照视频码率降序

默认取值:

ORIGINAL

min_video_bandwidth

Integer

参数解释:

视频码率过滤的最小码率

约束限制:

单位:bit/s;取值必须比max_video_bandwidth小

max_video_bandwidth

Integer

参数解释:

视频码率过滤的最大码率

约束限制:

单位:bit/s;取值必须比min_video_bandwidth大

响应参数

状态码:200

表16 响应Body参数

参数

参数类型

描述

result_code

String

错误码

result_msg

String

错误描述

domain

String

推流域名

app_name

String

组名或应用名,为必填项

id

String

频道ID。频道唯一标识,为必填项

sources

Array of SourceRsp objects

推流URL列表。创建频道时,只有入流协议为RTMP_PUSH时,会返回推流URL列表

表17 SourceRsp

参数

参数类型

描述

url

String

RTMP推流地址

bitrate

Integer

码率。

单位:bps。取值范围:(0,104,857,600](100Mbps)

width

Integer

分辨率对应宽的值。取值范围:0 - 4096(4K)

height

Integer

分辨率对应高的值。取值范围:0 - 2160(4K)

enable_snapshot

Boolean

描述是否使用该流做截图

状态码:400

表18 响应Body参数

参数

参数类型

描述

result_code

String

错误码

result_msg

String

错误描述

domain

String

推流域名

app_name

String

组名或应用名,为必填项

id

String

频道ID。频道唯一标识,为必填项

请求示例

PUT https://{endpoint}/v1/{project_id}/ott/channels/endpoints

{
  "domain" : "push.testott.hls.com",
  "app_name" : "ott",
  "id" : "test",
  "endpoints" : [ {
    "hls_package" : [ {
      "url" : "pull.testott.hls.com/ott/test/index.m3u8",
      "stream_selection" : [ {
        "key" : "sss",
        "max_bandwidth" : 1000,
        "min_bandwidth" : 100
      } ],
      "hls_version" : "1",
      "segment_duration_seconds" : 4,
      "playlist_window_seconds" : 3600
    } ],
    "dash_package" : [ {
      "url" : "pull.testott.hls.com/ott/test/index.mpd",
      "stream_selection" : [ {
        "key" : "bitrate=900000-1800000",
        "max_bandwidth" : 1800000,
        "min_bandwidth" : 900000
      } ],
      "segment_duration_seconds" : 4,
      "playlist_window_seconds" : 3600
    } ],
    "mss_package" : [ {
      "url" : "pull.testott.hls.com/ott/channel/manifest",
      "stream_selection" : [ {
        "key" : "bitrate=900000-1800000",
        "max_bandwidth" : 1800000,
        "min_bandwidth" : 900000
      } ],
      "segment_duration_seconds" : 4,
      "playlist_window_seconds" : 3600
    } ]
  } ]
}

响应示例

状态码:200

Demo Information

{
  "result_code" : "LIVE.100000000",
  "result_msg" : "SUCCESS",
  "domain" : "push.testott.hls.com",
  "app_name" : "ott",
  "id" : "test"
}

状态码:400

Error response

{
  "result_code" : "LIVE.100011001",
  "result_msg" : "param check failed",
  "domain" : "push.testott.hls.com",
  "app_name" : "ott",
  "id" : ""
}

状态码

状态码

描述

200

Demo Information

400

Error response

错误码

请参见错误码

相关文档