HotLiveRtcStream - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

QPS limit

The queries per second (QPS) limit for a single user is 10 calls per second. API calls that exceed this limit are throttled, which may affect your business. Plan your calls accordingly.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:HotLiveRtcStream

none

*Domain

acs:live:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	Yes	The streaming domain.	example.com
AppName	string	Yes	The application name of the live stream to prefetch.	app
StreamName	string	Yes	The name of the live stream to prefetch.	stream
RegionCode	string	Yes	The prefetch area. For more information, see the RegionCode lookup table. Note For regions within China, specify the corresponding code from the "Region codes for China" table. For all other regions, specify the country code. If the CodeRegionHasNoNode error is returned after you specify a RegionCode, the corresponding area is not covered by L1 nodes and cannot be prefetched. In this case, specify a different RegionCode.	ZHJ
AudioMsid	string	Yes	The audio Msid.	rts audio
VideoMsid	string	Yes	The video Msid.	rts video
ConnectionTimeout	string	No	The duration to maintain the prefetch connection. Unit: milliseconds. The default value, 0, means the connection is always maintained.	0
MediaTimeout	string	No	The custom timeout period for a timeout event. Unit: milliseconds.	100000

RegionCode lookup table

Region codes for China

Name	Code
Beijing	BEJ
Tianjin	TAJ
Hebei	HEB
Shanxi	SHX
Inner Mongolia	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
Tibet	TIB
Shaanxi	SHA
Gansu	GAN
Qinghai	QIH
Ningxia	NXA
Xinjiang	XIN
Taiwan	TAI
Hong Kong	HKG
Macao	MAC

Country codes

Name	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
Congo (DRC)	CD
Belgium	BE
Kazakhstan	KZ
Serbia	RS
Türkiye	TR
Namibia	NA
Lithuania	LT
Puerto Rico	PR
Congo (Brazzaville)	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
North 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 Darussalam	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
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 (Malvinas)	FK
North Korea	KP
Guatemala	GT
Bahamas	BS
Sri Lanka	LK
Singapore	SG
Bahrain	BH

Response elements

Element	Type	Description	Example
	object	The ID of the request.
RequestId	string	The request ID.	16BFE188-B193-4C3C-ADC5-79A7E31486EA

Examples

Success response

JSON format

{
  "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.
400	CodeRegionHasNoNode	this region has no corresponding node.
500	InternalError	The request processing has failed due to backend service exception.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.