Configures prefetch for a live stream that is ingested based on Real-Time Communication (RTC).
Operation description
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| live:HotLiveRtcStream | *Domain acs:live:*:{#accountId}:domain/{#DomainName} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DomainName | string | Yes | The streaming domain. | example.com |
| AppName | string | Yes | The name of the application to which the live stream belongs. | app |
| StreamName | string | Yes | The name of the live stream that you want to prefetch. | stream |
| RegionCode | string | Yes | The code of the region in which the live stream is prefetched. For more information, see the following tables that list available region codes. Note
Region codes include provincial codes for China and country codes for all countries.
| ZHJ |
| AudioMsid | string | Yes | The audio MSID. | rts audio |
| VideoMsid | string | Yes | The video MSID. | rts video |
| ConnectionTimeout | string | No | The duration for which the prefetch connection is maintained. Unit: milliseconds. Default value: 0, which specifies that the prefetch connection is always maintained. | 0 |
| MediaTimeout | string | No | The custom period after which a timeout event is triggered. Unit: milliseconds. | 100000 |
Region codes
Provincial codes for China
| Provincial division | Code |
|---|---|
| Beijing | BEJ |
| Tianjin | TAJ |
| Hebei | HEB |
| Shanxi | SHX |
| Nei Mongol | NMG |
| Liaoning | LIA |
| Jilin | JIL |
| Heilongjiang | HLJ |
| Shanghai | SHH |
| Jiangsu | JSU |
| Zhejiang | ZHJ |
| Anhui | ANH |
| Fujian | FUJ |
| Jiangxi | JXI |
| Shandong | SHD |
| Henan | HEN |
| Hubei | HUB |
| Hunan | HUN |
| Guangdong | GUD |
| Guangxi | GXI |
| Hainan | HAI |
| Chongqing | CHQ |
| Sichuan | SCH |
| Guizhou | GUI |
| Yunnan | YUN |
| Xizang | TIB |
| Shaanxi | SHA |
| Gansu | GAN |
| Qinghai | QIH |
| Ningxia | NXA |
| Xinjiang | XIN |
| Taiwan | TAI |
| Hong Kong | HKG |
| Macao | MAC |
Country codes for all countries
| Country | Code |
|---|---|
| Papua New Guinea | PG |
| Slovakia | SK |
| Peru | PE |
| Latvia | LV |
| United Arab Emirates | AE |
| Canada | CA |
| Cuba | CU |
| Mauritania | MR |
| Japan | JP |
| Armenia | AM |
| Turkmenistan | TM |
| Russia | RU |
| Belarus | BY |
| Guinea | GN |
| Iraq | IQ |
| Argentina | AR |
| Chile | CL |
| Eswatini | SZ |
| Democratic Republic of the Congo | CD |
| Belgium | BE |
| Kazakhstan | KZ |
| Serbia | RS |
| Türkiye | TR |
| Namibia | NA |
| Lithuania | LT |
| Puerto Rico | PR |
| Republic of the Congo | CG |
| New Caledonia | NC |
| Morocco | MA |
| Greenland | GL |
| Kuwait | KW |
| Liberia | LR |
| Ukraine | UA |
| Indonesia | ID |
| Myanmar | MM |
| Bolivia | BO |
| Moldova | MD |
| Greece | GR |
| New Zealand | NZ |
| Solomon Islands | SB |
| Ethiopia | ET |
| Fiji | FJ |
| Yemen | YE |
| Cyprus | CY |
| Bosnia and Herzegovina | BA |
| Eritrea | ER |
| Germany | DE |
| Pakistan | PK |
| Central African Republic | CF |
| Croatia | HR |
| Egypt | EG |
| Thailand | TH |
| Costa Rica | CR |
| Tanzania | TZ |
| Laos | LA |
| Libya | LY |
| Tunisia | TN |
| Poland | PL |
| United Kingdom | GB |
| Equatorial Guinea | GQ |
| China | CN |
| Iceland | IS |
| Oman | OM |
| Mongolia | MN |
| Chad | TD |
| United States | US |
| Mexico | MX |
| Kyrgyzstan | KG |
| Suriname | SR |
| India | IN |
| Guinea-Bissau | GW |
| Venezuela | VE |
| Italy | IT |
| Algeria | DZ |
| Qatar | QA |
| France | FR |
| South Africa | ZA |
| Norway | NO |
| Portugal | PT |
| Hungary | HU |
| South Korea | KR |
| Uzbekistan | UZ |
| Burundi | BI |
| Estonia | EE |
| Bangladesh | BD |
| Bhutan | BT |
| Afghanistan | AF |
| Switzerland | CH |
| Belize | BZ |
| Timor-Leste | TL |
| Haiti | HT |
| Togo | TG |
| Albania | AL |
| Cameroon | CM |
| Nicaragua | NI |
| Nigeria | NG |
| Honduras | HN |
| Burkina Faso | BF |
| Mozambique | MZ |
| Georgia | GE |
| Vanuatu | VU |
| Paraguay | PY |
| Luxembourg | LU |
| Lebanon | LB |
| Uganda | UG |
| Mali | ML |
| Saudi Arabia | SA |
| Palestine | PS |
| Montenegro | ME |
| Colombia | CO |
| Philippines | PH |
| Sweden | SE |
| Finland | FI |
| Kenya | KE |
| Romania | RO |
| Panama | PA |
| Jordan | JO |
| Rwanda | RW |
| Lesotho | LS |
| Macedonia | MK |
| Zambia | ZM |
| Syria | SY |
| Spain | ES |
| Ecuador | EC |
| Gabon | GA |
| Ireland | IE |
| Dominican Republic | DO |
| Ghana | GH |
| Madagascar | MG |
| Malaysia | MY |
| Austria | AT |
| Tajikistan | TJ |
| Denmark | DK |
| Uruguay | UY |
| Cambodia | KH |
| Senegal | SN |
| El Salvador | SV |
| Sierra Leone | SL |
| Brunei | BN |
| Western Sahara | EH |
| Niger | NE |
| Iran | IR |
| Guyana | GY |
| Angola | AO |
| Botswana | BW |
| Brazil | BR |
| Australia | AU |
| Côte d'Ivoire | CI |
| Czech Republic | CZ |
| The Gambia | GM |
| Benin | BJ |
| Vietnam | VN |
| Sudan | SD |
| Netherlands | NL |
| Djibouti | DJ |
| Slovenia | SI |
| Nepal | NP |
| Zimbabwe | ZW |
| Jamaica | JM |
| Malawi | MW |
| Azerbaijan | AZ |
| Somalia | SO |
| Israel | IL |
| Falkland Islands (Islas Malvinas) | FK |
| North Korea | KP |
| Guatemala | GT |
| Bahamas | BS |
| Sri Lanka | LK |
| Singapore | SG |
| Bahrain | BH |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "16BFE188-B193-4C3C-ADC5-79A7E31486EA"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidParam | Parameter invalid. | Illegal input parameters |
| 400 | NoSpecialConfiguration | no special configuration for domain name. | The domain name does not open the preheating switch. |
| 400 | CodeRegionHasNoNode | this region has no corresponding node. | - |
| 500 | InternalError | The request processing has failed due to backend service exception. | - |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|