设置RTC流预热。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| live:HotLiveRtcStream | none | *Domain acs:live:*:{#accountId}:domain/{#DomainName} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DomainName | string | 是 | 播流域名。 | example.com |
| AppName | string | 是 | 预热直播流 App 名称。 | app |
| StreamName | string | 是 | 预热直播流名称。 | stream |
| RegionCode | string | 是 | 预热区域,详细内容请查看 RegionCode 对应简码表格。 说明
预热区域粒度海外是国家简码,中国或中国内地是各省简码。
| ZHJ |
| AudioMsid | string | 是 | 音频 Msid。 | rts audio |
| VideoMsid | string | 是 | 视频 Msid。 | rts video |
| ConnectionTimeout | string | 否 | 预热链接保持的时间,单位毫秒。默认 0 是一直保持。 | 0 |
| MediaTimeout | string | 否 | 自定义超时事件的触发时间。单位毫秒。 | 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 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "16BFE188-B193-4C3C-ADC5-79A7E31486EA"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParam | Parameter invalid. | 输入参数不合法 |
| 400 | NoSpecialConfiguration | no special configuration for domain name. | 该域名没有开启预热开关。 |
| 400 | CodeRegionHasNoNode | this region has no corresponding node. | - |
| 500 | InternalError | The request processing has failed due to backend service exception. | - |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2025-02-11 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |
