All Products
Search
Document Center

ApsaraVideo Live:AddLiveDomain

Last Updated:Jul 18, 2024

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

Usage note

  • You must activate ApsaraVideo Live before adding any domain name. For instructions, see Activate ApsaraVideo Live and purchase resource plans.

  • You must obtain an Internet content provider (ICP) filling for a domain name to be added to ApsaraVideo Live.

  • Only one domain name can be submitted at a time.

  • When adding a domain name to ApsaraVideo Live for the first time, you must verify the ownership of the domain name first. For instructions, see Verify the ownership of a domain name.

Important
  • Since February 19, 2019, domain names added by using the AddLiveDomain operation and the AddCdnDomain operation cannot use live center ingest. That means only edge ingest is available for the domain names added since then.

  • Due to the above mentioned fact, you must first add an ingest domain (by setting the LiveDomainType parameter to liveEdge ) and a streaming domain (by setting the LiveDomainType parameter to liveVideo ). Then, call the AddLiveDomainMapping operation to bind the ingest domain and the streaming domain.

  • Live domains created by using the AddLiveDomain operation before February 19, 2019 still support live center ingest.

QPS limit

A single user can perform a maximum of 30 queries per second (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.

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

example.aliyundoc.com

The ingest domain or streaming domain 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. Set the value to liveVideo if the domain name being added is used for playing the streams.

  • liveEdge: ingest domain. Set the value to liveEdge if the domain name being added is used for pushing the streams.

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) Closing Down

  • ap-southeast-5: Indonesia (Jakarta)

CheckUrl

String

No

http://demo.aliyundoc.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

learn.aliyundoc.com

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=example.aliyundoc.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.