AddLiveDomain - ApsaraVideo Live - Alibaba Cloud Documentation Center

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.

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. 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
DomainName	string	Yes	The ingest domain or streaming domain that you want to add. Wildcard domain names that start with a period (.) are supported.	example.aliyundoc.com
Region	string	Yes	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
CheckUrl	string	No	The URL that is used for health checks.	http://demo.aliyundoc.com/status.html
Scope	string	No	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
TopLevelDomain	string	No	The top-level domain name.	learn.aliyundoc.com
ResourceGroupId	string	No	The ID of the resource group. For more information about resource groups, see Resource groups.	rg-aekzw******
Tag	array<object>	No	The tags.
	object	No	The tag.
Key	string	No	The key of the tag.	TestKey
Value	string	No	The value of the tag.	TestValue

Response elements

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

Examples

Success response

JSON format

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

Error response

JSON format

{
	"Code":"InternalError",
	"HostId":"live.aliyuncs.com",
	"Message":"The request processing has failed due to some unknown error.",
	"RequestId":"6EBD1AC4-C34D-4BE1-963E-B688A228BE31"
}

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