全部产品
Search
文档中心

视频直播:HotLiveRtcStream - 设置RTC流预热

更新时间:Nov 14, 2024

设置RTC流预热。

接口说明

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:HotLiveRtcStream
*Domain
acs:live:*:{#accountId}:domain/{#DomainName}

请求参数

名称类型必填描述示例值
DomainNamestring

播流域名。

example.com
AppNamestring

预热直播流 App 名称。

app
StreamNamestring

预热直播流名称。

stream
RegionCodestring

预热区域,详细内容请查看 RegionCode 对应简码表格。

说明 预热区域粒度海外是国家简码,中国或中国内地是各省简码。
ZHJ
AudioMsidstring

音频 Msid。

rts audio
VideoMsidstring

视频 Msid。

rts video
ConnectionTimeoutstring

预热链接保持的时间,单位毫秒。默认 0 是一直保持。

0
MediaTimeoutstring

自定义超时事件的触发时间。单位毫秒。

100000

RegionCode 对应简码

中国或中国内地代码

中文名简码
北京市BEJ
天津市TAJ
河北省HEB
山西省SHX
内蒙古自治区NMG
辽宁省LIA
吉林省JIL
黑龙江省HLJ
上海市SHH
江苏省JSU
浙江省ZHJ
安徽省ANH
福建省FUJ
江西省JXI
山东省SHD
河南省HEN
湖北省HUB
湖南省HUN
广东省GUD
广西壮族自治区GXI
海南省HAI
重庆市CHQ
四川省SCH
贵州省GUI
云南省YUN
西藏自治区TIB
陕西省SHA
甘肃省GAN
青海省QIH
宁夏回族自治区NXA
新疆维吾尔自治区XIN
台湾省TAI
香港特别行政区HKG
澳门特别行政区MAC

国家代码

中文名简码
巴布亚新几内亚PG
斯洛伐克SK
秘鲁PE
拉脱维亚LV
阿拉伯联合酋长国AE
加拿大CA
古巴CU
毛里塔尼亚MR
日本JP
亚美尼亚AM
土库曼斯坦TM
俄罗斯RU
白俄罗斯BY
几内亚GN
伊拉克IQ
阿根廷AR
智利CL
斯威士兰SZ
刚果CD
比利时BE
哈萨克斯坦KZ
塞尔维亚RS
土耳其TR
纳米比亚NA
立陶宛LT
波多黎各PR
刚果共和国CG
新喀里多尼亚NC
摩洛哥MA
格陵兰岛GL
科威特KW
利比里亚LR
乌克兰UA
印度尼西亚ID
缅甸MM
玻利维亚BO
摩尔多瓦MD
希腊GR
新西兰NZ
索罗门群岛SB
埃塞俄比亚ET
斐济FJ
也门YE
塞浦路斯CY
波斯尼亚和黑塞哥维那BA
厄立特里亚ER
德国DE
巴基斯坦PK
中非共和国CF
克罗地亚HR
埃及EG
泰国TH
哥斯达黎加CR
坦桑尼亚TZ
老挝LA
利比亚LY
突尼斯TN
波兰PL
英国GB
赤道几内亚GQ
中国CN
冰岛IS
阿曼OM
蒙古MN
乍得TD
美国US
墨西哥MX
吉尔吉斯斯坦KG
苏里南SR
印度IN
几内亚比绍GW
委内瑞拉VE
意大利IT
阿尔及利亚DZ
卡塔尔QA
法国FR
南非ZA
挪威NO
葡萄牙PT
匈牙利HU
韩国KR
乌兹别克斯坦UZ
布隆迪BI
爱沙尼亚EE
孟加拉国BD
不丹BT
阿富汗AF
瑞士CH
伯利兹BZ
东帝汶TL
海地HT
多哥TG
阿尔巴尼亚AL
喀麦隆CM
尼加拉瓜NI
尼日利亚NG
洪都拉斯HN
布基纳法索BF
莫桑比克MZ
格鲁吉亚GE
瓦努阿图VU
巴拉圭PY
卢森堡LU
黎巴嫩LB
乌干达UG
马里ML
沙特阿拉伯SA
巴勒斯坦PS
黑山ME
哥伦比亚CO
菲律宾PH
瑞典SE
芬兰FI
肯尼亚KE
罗马尼亚RO
巴拿马PA
约旦JO
卢旺达RW
莱索托LS
马其顿MK
赞比亚ZM
叙利亚SY
西班牙ES
厄瓜多尔EC
加蓬GA
爱尔兰IE
多米尼加共和国DO
加纳GH
马达加斯加MG
马来西亚MY
奥地利AT
塔吉克斯坦TJ
丹麦DK
乌拉圭UY
柬埔寨KH
塞内加尔SN
萨尔瓦多SV
塞拉利昂SL
文莱达鲁萨兰国BN
西撒哈拉EH
尼日尔NE
伊朗IR
圭亚那GY
安哥拉AO
博茨瓦纳BW
巴西BR
澳大利亚AU
科特迪瓦CI
捷克共和国CZ
冈比亚GM
贝宁BJ
越南VN
苏丹SD
荷兰NL
吉布提DJ
斯洛文尼亚SI
尼泊尔NP
津巴布韦ZW
牙买加JM
马拉维MW
阿塞拜疆AZ
索马里SO
以色列IL
福克兰群岛(马尔维纳斯群岛)FK
朝鲜KP
危地马拉GT
巴哈马BS
斯里兰卡LK
新加坡SG
巴林BH

返回参数

名称类型描述示例值
object

请求 ID。

RequestIdstring

请求 ID。

16BFE188-B193-4C3C-ADC5-79A7E31486EA

示例

正常返回示例

JSON格式

{
  "RequestId": "16BFE188-B193-4C3C-ADC5-79A7E31486EA"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamParameter invalid.输入参数不合法
400NoSpecialConfigurationno special configuration for domain name.该域名没有开启预热开关。
400CodeRegionHasNoNodethis region has no corresponding node.-
500InternalErrorThe request processing has failed due to backend service exception.-

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史