Adds a domain name to ApsaraVideo Live. This operation allows you to add only one domain name at a time.

Limits

  • You must activate ApsaraVideo Live before you can create a domain name. For more information, see Activate ApsaraVideo Live and purchase resource plans.
  • You must obtain an Internet content provider (ICP) filling for a domain name before you can add the domain name to ApsaraVideo Live.
Note Since February 19, 2019, domain names added by using the AddLiveDomain operation and the AddCdnDomain operation do not support live center ingest. To use live center ingest, perform the following steps: Call the AddLiveDomain operation and set the LiveDomainType parameter to liveEdge to create an ingest domain. Call the AddLiveDomain operation and set the LiveDomainType parameter to liveVideo to create a streaming domain. Then, call the AddLiveDomainMapping operation to map the ingest domain to the streaming domain. Live domains created by using the AddLiveDomain operation before February 19, 2019 still support live center ingest.

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.

DomainName String Yes live.yourdomain.com

The domain name that you want to add. Wildcard domain names that start with a period (.) are supported.

LiveDomainType String Yes liveVideo

The type of the domain name. Valid values:

  • liveVideo: streaming domain
  • liveEdge: edge ingest domain
Region String Yes cn-beijing

The region where 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-south-1: India (Mumbai)
  • ap-southeast-5: Indonesia (Jakarta)
CheckUrl String No http://live.yourdomain.com/status.html

The URL that is used for health checks.

Scope String No domestic

The edge group. This parameter is applicable to users of level 3 or higher in mainland China and users outside mainland China. Valid values:

  • domestic: mainland China. This is the default value.
  • overseas: outside mainland China.
  • global: regions in and outside mainland China.
TopLevelDomain String No www.yourTopLevelDomain

The top-level domain name.

Response parameters

Parameter Type Example Description
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

The ID of the request.

Examples

Sample requests

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

Sample success responses

XML format

<AddLiveDomainResponse>
      <RequestId>15C66C7B-671A-4297-9187-2C4477247A74</RequestId>
</AddLiveDomainResponse>

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.