All Products
Search
Document Center

ApsaraVideo Live:AddLiveDomain

Last Updated:Mar 20, 2025
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

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

Operation description

  • 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.
Note 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.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
live:AddLiveDomaincreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LiveDomainTypestringYes

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.
liveVideo
DomainNamestringYes

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

example.aliyundoc.com
RegionstringYes

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.
cn-beijing
CheckUrlstringNo

The URL that is used for health checks.

http://demo.aliyundoc.com/status.html
ScopestringNo

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.
domestic
TopLevelDomainstringNo

The top-level domain name.

learn.aliyundoc.com
ResourceGroupIdstringNo

The ID of the resource group. For more information about resource groups, see Resource groups.

rg-aekzw******
Tagarray<object>No

The tags.

objectNo

The tag.

KeystringNo

The key of the tag.

TestKey
ValuestringNo

The value of the tag.

TestValue

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InvalidDomainName.MalformedSpecified DomainName is malformed.-
400InvalidRegion.MalformedSpecified Region is malformed.The specified area is invalid.
400InvalidSource.Content.MalformedSpecified source content is malformed.-
400InvalidTypeContent.MismatchSpecified source type does not math the specified source content.-
400MissingSource.ContentSpecified source content is mandatory for this action.-
400MissingSource.TypeSpecified source type is mandatory for this action.-
400InvalidSource.Type.MalformedSpecified source type is malformed.-
400InvalidSource.Priority.MalformedSpecified source priority is malformed.-
400InvalidScope.MalformedSpecified Scope is malformed.-
400SourceIp.ExceedThe Certificate you provided is malformed!-
400InvalidCertificateThe Certificate you provided is malformed!-
400InvalidCertificate.TooLongThe Certificate you provided is over the max length!-
400InnerAddDomainDeniedYour account haven't bind aoneId, can not add domain.-
400CheckSourceHealthFailedsources ip or source domain check health failed,please input right source.-
400ExtensiveAndAllBothExistExtensive domain and the domain begins with 'all.' can not exist at the same time.-
400CdnTypeNotSupportExtensiveDomainExtensive domain not supported for this cdn type.-
400ExtensiveAndSpecificDomainConflictExtensive domain and corresponding specific domain are mutually exclusive.Extensive domain and corresponding specific domain are mutually exclusive.
400InvalidDomainNameLevelDomain name suffixed with alicdn.com only support third level.-
400TopLevelDomain.NotFoundTopLevelDomain is not exist.-
400EntityNotExists.ResourceGroupThe resource group does not exist.-
400InvalidStatus.ResourceGroupIt's now allowed to do this operation because of the current status of resource-group.-
400NotInternationRealIdentityYou need to do real name authentication when you use Chinese mainland resources.-
400RecordCheckNotAvailablePlease try again later.-
400IcpBlackThe domain is on the ICP blacklist.-
400IspBlackThe domain is on the ISP blacklist.-
400DomainNotRecordedAliyunThe domain not access Ali Cloud for the record please access.-
400Abs.CheckUrl.MalformedThe CheckUrl you provided is malformed!-
400DomainOwnerVerifyFailOwner verification of the root domain failed.-
400TopLevelDomain.MismatchThe specified TopLevelDomain does not match webSiteType.-
400InvalidResourceGroupId.MalformedSpecified ResourceGroupId is malformed.-
400DomainReservedThe root domain of your domain is reserved by another account.The root domain is added to other accounts.
400ExceedLimitThe number of domains has exceeded the limit.The number of domains has exceeded the limit.
400LockFailDomain has been occupied.-
403AccountExceptionAccount exception. Please open ticket to make an appeal.-
403EntityNotExist.ResourceGroupThe resource group does not exist.The resource group does not exist.
404InvalidUserThe user's account is invalid.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-10-24The Error code has changed. The request parameters of the API has changedView Change Details
2024-09-27API Description Update. The Error code has changedView Change Details
2024-09-25The Error code has changed. The request parameters of the API has changedView Change Details
2023-05-09The Error code has changedView Change Details