Configure Live Domains via AddLiveDomain API to Enable Streaming - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Adds a live streaming domain name. You can add only one domain name at a time.

Operation description

Before you add a live streaming domain name, you must activate ApsaraVideo Live. For more information, see Activate the service.
Before you add a new domain name, you must first verify the domain name ownership and then call this operation to add the domain name. You can use DNS resolution verification or file verification. For more information, see Verify domain name ownership.
ApsaraVideo Live requires both stream ingest and streaming. You must add an ingest domain and a streaming domain separately. You can commit only one domain name at a time.
After you add a domain name, you must configure CNAME resolution for the domain name. For more information, see Configure CNAME resolution.
After you add an ingest domain and a streaming domain, you must associate the associated domains before you can use ApsaraVideo Live. For more information, see Associated domain.

Important Starting from February 19, 2019, domain names added by using AddLiveDomain do not support live center ingest. New domain names added by using CDN API operations also do not support live center ingest. Use edge ingest to add an ingest domain (call AddLiveDomain with the business type set to liveEdge) and a streaming domain (call AddLiveDomain with the business type set to liveVideo), and then associate them (call AddLiveDomainMapping). Domain names added before February 19, 2019 are not affected.

QPS limit

The single-user QPS limit for this operation is 30 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation appropriately.

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:AddLiveDomain

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
LiveDomainType	string	Yes	The type of the domain name. Valid values: liveVideo: streaming domain. If you set DomainName (the domain name to be connected to ApsaraVideo Live) to a streaming domain, you must set this parameter to liveVideo. liveEdge: edge ingest domain. If you set DomainName (the domain name to be connected to ApsaraVideo Live) to an ingest domain, you must set this parameter to liveEdge. Valid values: liveEdge : edge ingest domain. liveGrtnPub : GRTN ingest domain. liveGrtnSub : GRTN streaming domain. liveVideo : streaming domain.	liveVideo
DomainName	string	Yes	The ingest domain or streaming domain to be connected to ApsaraVideo Live. Wildcard domain names are supported and must start with a period (.).	example.aliyundoc.com
Region	string	Yes	The unit information of the live streaming domain name. Valid values: cn-beijing: Beijing. cn-shanghai: Shanghai. cn-shenzhen: Shenzhen. cn-qingdao: Qingdao. ap-southeast-1: Singapore. eu-central-1: Germany. ap-northeast-1: Tokyo. ap-southeast-5: Jakarta. Note Region (unit information of the live streaming domain name) and Scope (acceleration region) do not restrict each other.	cn-beijing
CheckUrl	string	No	The health check URL.	http://demo.aliyundoc.com/status.html
Scope	string	No	The acceleration region. This parameter takes effect for international users and China site users at L3 or above. Valid values: domestic (default): the Chinese mainland. overseas: outside the Chinese mainland, including Hong Kong (China), Macao (China), and Taiwan (China). global: global acceleration.	domestic
TopLevelDomain	string	No	The top-level domain name for access.	learn.aliyundoc.com
ResourceGroupId	string	No	The resource group ID. For more information about resource groups, see What is a resource group.	rg-aekzw******
Tag	array<object>	No	The list of tags.
	object	No	The list of tags.
Key	string	No	The tag key.	TestKey
Value	string	No	The tag value.	TestValue

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

Examples

Success response

JSON format

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDomainName.Malformed	Specified DomainName is malformed.
400	InvalidRegion.Malformed	Specified Region is malformed.	The specified area is invalid.
400	InvalidSource.Content.Malformed	Specified source content is malformed.
400	InvalidTypeContent.Mismatch	Specified source type does not math the specified source content.
400	MissingSource.Content	Specified source content is mandatory for this action.
400	MissingSource.Type	Specified source type is mandatory for this action.
400	InvalidSource.Type.Malformed	Specified source type is malformed.
400	InvalidSource.Priority.Malformed	Specified source priority is malformed.
400	InvalidScope.Malformed	Specified Scope is malformed.
400	SourceIp.Exceed	The Certificate you provided is malformed!
400	InvalidCertificate	The Certificate you provided is malformed!
400	InvalidCertificate.TooLong	The Certificate you provided is over the max length!
400	InnerAddDomainDenied	Your account haven't bind aoneId, can not add domain.
400	CheckSourceHealthFailed	sources ip or source domain check health failed，please input right source.
400	ExtensiveAndAllBothExist	Extensive domain and the domain begins with 'all.' can not exist at the same time.
400	CdnTypeNotSupportExtensiveDomain	Extensive domain not supported for this cdn type.
400	ExtensiveAndSpecificDomainConflict	Extensive domain and corresponding specific domain are mutually exclusive.	Extensive domain and corresponding specific domain are mutually exclusive.
400	InvalidDomainNameLevel	Domain name suffixed with alicdn.com only support third level.
400	TopLevelDomain.NotFound	TopLevelDomain is not exist.
400	EntityNotExists.ResourceGroup	The resource group does not exist.
400	InvalidStatus.ResourceGroup	It's now allowed to do this operation because of the current status of resource-group.
400	NotInternationRealIdentity	You need to do real name authentication when you use Chinese mainland resources.	You must use a valid authorized identity to access resources in the Chinese mainland.
400	RecordCheckNotAvailable	Please try again later.
400	IcpBlack	The domain is on the ICP blacklist.
400	IspBlack	The domain is on the ISP blacklist.
400	DomainNotRecordedAliyun	The domain not access Ali Cloud for the record please access.
400	Abs.CheckUrl.Malformed	The CheckUrl you provided is malformed!
400	DomainOwnerVerifyFail	Owner verification of the root domain failed.
400	TopLevelDomain.Mismatch	The specified TopLevelDomain does not match webSiteType.
400	InvalidResourceGroupId.Malformed	Specified ResourceGroupId is malformed.
400	DomainReserved	The root domain of your domain is reserved by another account.	The root domain is added to other accounts.
400	ExceedLimit	The number of domains has exceeded the limit.	The number of domains has exceeded the limit.
400	LockFail	Domain has been occupied.	The domain name is currently in use. Please try again later.
403	AccountException	Account exception. Please open ticket to make an appeal.
403	EntityNotExist.ResourceGroup	The resource group does not exist.	The resource group does not exist.
404	InvalidUser	The user's account is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.