You can call this operation to add a domain to Alibaba Cloud CDN as an accelerated domain.
- You can specify only one domain name in each request. You can add a maximum of 20 domains.
- Make sure that you have activated Alibaba Cloud CDN.
- Make sure that you have obtained an Internet content provider (ICP) filing for the domain.
- If the origin content is not saved on Alibaba Cloud, the content must be reviewed. The review will be completed by the end of the next working day after you submit the application.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | AddCdnDomain |
The operation that you want to perform. Set the value to AddCdnDomain. |
CdnType | String | Yes | web |
The workload type of the accelerated domain. Valid values:
|
DomainName | String | Yes | .a.com |
The name of the domain to be added to Alibaba Cloud CDN. Wildcard domain names are supported. A wildcard domain name must start with a period (.). |
CheckUrl | String | No | www.yourdomain.com/test.html |
The URL to check the availability of the origin. |
Priorities | String | No | 20 |
The priority of each origin if multiple origins are specified. Separate the priority values with commas (,). Make sure that the number of priority values is the same as the number of origins. |
Region | String | No | cn-shanghai |
The region ID of the live domain. Valid values: cn-beijing, cn-shanghai, cn-shenzhen, and ap-southeast-1. |
ResourceGroupId | String | No | your resourceGroupId |
The ID of the resource group. |
Scope | String | No | domestic |
The acceleration region of the domain. Valid values:
|
SourcePort | Integer | Optional | 80 |
The port of the origin. Valid values: 443 and 80. Default value: 80. If you specify port 443, Alibaba Cloud CDN will communicate with the origin over HTTPS. If you set the SourceType parameter to oss, port 443 is not supported. |
SourceType | String | No | domain |
The type of the origin. Valid values:
Note If you set the CdnType parameter to liveStream, you do not need to specify the origin
type or origin information.
|
Sources | String | No | www.yourdomain.com |
The address of the origin, which can be an IP address or a domain name.
|
TopLevelDomain | String | No | www.yourTopLevelDomain |
The top-level scheduling domain. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8 |
The ID of the request. |
Examples
Sample requests
http://cdn.aliyuncs.com?Action=AddCdnDomain
&CdnType=web
&SourceType=domain
&DomainName=example.com
&Sources=example.com
&<Common request parameters>
Sample success responses
XML
format
<AddCdnDomainResponse>
<RequestId>A22F5DDD-E6B8-4DB4-A210-FF3CA5A82644</RequestId>
</AddCdnDomainResponse>
JSON
format
{
"RequestId":"15C66C7B-671A-4297-9187-2C4477247A74"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | MissingParameter | The input parameter cdnType that is mandatory for processing this request is not supplied. | The error message returned because the CdnType parameter must be specified. |
400 | MissingParameter | The input parameter sourceType that is mandatory for processing this request is not supplied. | The error message returned because the SourceType parameter must be specified. |
400 | MissingParameter | The input parameter region that is mandatory for processing this request is not supplied. | The error message returned because the Region parameter must be specified. |
400 | Region.NotExist | The input parameter region is not exist. | The error message returned because the specified Region parameter does not exist. |
400 | InvalidDomainName.Malformed | Specified DomainName is malformed. | The error message returned because the specified DomainName parameter is invalid. |
400 | InvalidCdnType.Malformed | Specified CdnType is malformed. | The error message returned because the specified CdnType parameter is invalid. Valid values: web, download, video, and liveStream. |
400 | InvalidSourceType.Malformed | Specified CdnType is malformed. | The error message returned because the specified CdnType parameter is invalid. |
400 | InvalidSources.Malformed | Specified Sources is malformed. | The error message returned because the specified Sources parameter is invalid. You can specify up to 20 IP addresses that are separated with commas (,) or one domain name. You cannot specify both IP addresses and domain name in one request. |
400 | InvalidSourcePort.Malformed | Specified port is not supported. | The error message returned because the specified SourcePort parameter is not supported. |
400 | InvalidScope.Malformed | Specified Scope is malformed. | The error message returned because the specified Scope parameter is invalid. |
400 | InvalidTopLevelDomain.Malformed | Specified TopLevelDomain is malformed. | The error message returned because the specified TopLevelDomain parameter is invalid. |
400 | SourceIp.Exceed | The Certificate you provided is malformed! | The error message returned because the specified certificate is invalid. |
400 | InvalidCertificate | The Certificate you provided is malformed! | The error message returned because the specified certificate is invalid. |
400 | InvalidCertificate.TooLong | The Certificate you provided is over the max length! | The error message returned because the length of the specified certificate and private key exceeds the upper limit. |
400 | InnerAddDomainDenied | Your account haven't bind aoneId, can not add domain. | The error message returned because you cannot add a domain by using an account that has not been bound to an Aone ID. |
400 | ExtensiveAndAllBothExist | Extensive domain and the domain begins with 'all.' can not exist at the same time. | The error message returned because wildcard domain names and domain names starting with string "all." cannot exist at the same time. |
400 | CdnTypeNotSupportExtensiveDomain | Extensive domain not supported for this cdn type. | The error message returned because wildcard domains do not support the specified workload type. Wildcard domains only support the following workload types: web, download, and video. |
400 | ExtensiveAndSpecificDomainConflict | Extensive domain and corresponding specific domain are mutually exclusive. | The error message returned because the wildcard domain name matches an existing exact domain name at the corresponding level. Wildcard domain names and the matching exact domain names are mutually exclusive. |
400 | InvalidParameter | Add live region parameters have error. | The error message returned because the specified Region parameter is invalid. |
400 | InvalidRegion.Malformed | Specified Region is malformed. | The error message returned because the specified Region parameter is invalid. |
400 | InvalidParameter | There is unsupported parameter. | The error message returned because the specified parameter is not supported. |
400 | InvalidResourceGroupId.Malformed | Specified ResourceGroupId is malformed. | The error message returned because the specified ResourceGroupId parameter is invalid. |
400 | InvalidDomainNameLevel | Domain name suffixed with alicdn.com only support third level. | The error message returned because the specified domain is not supported. Alibaba Cloud CDN supports up to four levels in an accelerated domain name. |
400 | TopLevelDomain.NotFound | TopLevelDomain is not exist. | The error message returned because the specified TopLevelDomain parameter does not exist. |
400 | EntityNotExists.ResourceGroup | The resource group does not exist. | The error message returned because the specified resource group does not exist. |
400 | InvalidStatus.ResourceGroup | It's now allowed to do this operation because of the current status of resource-group. | The error message returned because the operation is not allowed when the resource group is in the current state. |
400 | InvalidPriorities.Malformed | The length of priorities is not the same with source. | The error message returned because the number of priority values does not match the number of origins. |
400 | NotInternationRealIdentity | You need to do real name authentication when you use Chinese mainland resources. | The error message returned because you have not completed the real-name authentication that is required to use resources in mainland China. |
For a list of error codes, visit the API Error Center.