AddLiveDomain - ApsaraVideo Live

Usage notes

You must activate ApsaraVideo Live before you add a domain name. For more information, see Activate ApsaraVideo Live.
ApsaraVideo Live verifies the ownership of a new domain name that you add. After the verification is passed, the domain name is added to ApsaraVideo Live. ApsaraVideo Live allows you to use a Domain Name System (DNS) record or a verification file to verify the ownership of a domain name. For more information, see Verify the ownership of a domain name.
To use ApsaraVideo Live to ingest and play streams, you must add an ingest domain and a streaming domain. You can add only one domain name at a time.
After you add a domain name, you must configure a CNAME record for the domain name. For more information, see Add a CNAME record.
After you add an ingest domain and a streaming domain, you must associate the streaming domain with the ingest domain. For more information, see Associate a streaming domain with an ingest domain.

Important From February 19, 2019, domain names that are added by calling the AddLiveDomain operation do not support live center ingest. Domain names that are added by using Alibaba Cloud CDN also do not support live center ingest. When you call the AddLiveDomain operation, you can set the LiveDomainType parameter to liveEdge to add an ingest domain that uses edge ingest or set the LiveDomainType parameter to liveVideo to add a streaming domain. You can associate a streaming domain with an ingest domain by calling the AddLiveDomainMapping operation. Domain names added before February 19, 2019, for which live center ingest was configured, are not affected.

QPS limit

You can call this operation up to 30 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	AddLiveDomain	The operation that you want to perform. Set the value to AddLiveDomain.
LiveDomainType	String	Yes	liveVideo	The type of the domain name. Valid values: liveVideo: streaming domain. This value is required if you set the DomainName parameter to a streaming domain. liveEdge: ingest domain. This value is required if you set the DomainName parameter to an ingest domain.
DomainName	String	Yes	example.aliyundoc.com	The ingest domain or streaming domain that you want to add to ApsaraVideo Live. Wildcard domain names that start with a period (.) are supported.
Region	String	Yes	cn-beijing	The region in which the domain name resides. Valid values: cn-beijing: China (Beijing) cn-shanghai: China (Shanghai) cn-shenzhen: China (Shenzhen) cn-qingdao: China (Qingdao) ap-southeast-1: Singapore eu-central-1: Germany (Frankfurt) ap-northeast-1: Japan (Tokyo) ap-southeast-5: Indonesia (Jakarta) Note Make sure that the settings of the Region and Scope parameters do not conflict with each other.
CheckUrl	String	No	http://demo.aliyundoc.com/status.html	The URL that is used to check the health status of the domain name.
Scope	String	No	domestic	The acceleration region. This parameter is applicable to users of level 3 or higher in the Chinese mainland and all users outside the Chinese mainland. Valid values: domestic (default): the Chinese mainland overseas: outside the Chinese mainland global: in and outside the Chinese mainland
TopLevelDomain	String	No	learn.aliyundoc.com	The top-level domain name.

Response parameters

Parameter	Type	Example	Description
RequestId	String	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8	The request ID.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=AddLiveDomain
&DomainName=example.aliyundoc.com
&LiveDomainType=liveVideo
&Region=cn-beijing
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<AddLiveDomainResponse>
	<RequestId>15C66C7B-671A-4297-9187-2C4477247A74</RequestId>
</AddLiveDomainResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "AddLiveDomainResponse" : {
    "RequestId" : "15C66C7B-671A-4297-9187-2C4477247A74"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	NotInternationRealIdentity	You need to do real name authentication when you use Chinese mainland resources.	You must obtain authorization to access resources from the Chinese mainland.
400	DomainReserved	The root domain of your domain is reserved by another account.	The root domain is added to other accounts.

For a list of error codes, see Service error codes.