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
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| live:AddLiveDomain | create | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| LiveDomainType | string | Yes | The type of the domain name. Valid values:
| 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:
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 |
| 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 parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}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. | - |
| 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. | - |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-10-24 | The Error code has changed. The request parameters of the API has changed | View Change Details |
| 2024-09-27 | API Description Update. The Error code has changed | View Change Details |
| 2024-09-25 | The Error code has changed. The request parameters of the API has changed | View Change Details |
| 2023-05-09 | The Error code has changed | View Change Details |