Adds a domain name to Alibaba Cloud Content Delivery Network (CDN).

Note
  • You must activate Alibaba Cloud CDN before you can add a domain name to it. For more information, see Activate Alibaba Cloud CDN.
  • The domain name that you want to add has a valid Internet Content Provider (ICP) number.
  • You can add only one domain name to Alibaba Cloud CDN in each call. Each Alibaba Cloud account can add a maximum of 50 domain names to Alibaba Cloud CDN.
  • If the content of the origin server is not stored on Alibaba Cloud, the content must be reviewed. The review will be completed by the end of the next business day after you submit the application.
  • The maximum number of times that each user can call this operation per second is 30.

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 AddCdnDomain

The operation that you want to perform. Set the value to AddCdnDomain.

CdnType String Yes web

The workload type of the domain name. Valid values:

  • web: images and small files.
  • download: large files.
  • video: on-demand video and audio streaming.
DomainName String Yes .example.com

The domain names that you want to add to Alibaba Cloud CDN.

Wildcard domain names are supported.A wildcard domain name must start with a period (.), such as .example.com.

Sources String Yes [{"content":"1.1.1.1","type":"ipaddr","priority":"20","port":80,"weight":"15"}]

The information about the origin address.

ResourceGroupId String No rg-acfmyuji4b6r4**

The ID of the resource group.

If you do not set this parameter, the system uses the ID of the default resource group.

CheckUrl String No www.yourdomain.com/test.html

The URL that is used for health checks.

Scope String No domestic

The accelerated region. Valid values:

  • domestic: regions in mainland China.
  • overseas: regions outside mainland China.
  • global: regions inside and outside mainland China.

Default value: domestic.

TopLevelDomain String No example.com

The top-level domain name.

The following table describes the fields of the Sources parameter.

Parameter

Type

Required

Description

type

String

Yes

The type of the origin server. Valid values:

ipaddr: The origin server uses an IP address.

domain: The origin server uses a domain name.

oss: The origin server is an Object Storage Service (OSS) bucket.

fc_domain: The origin server uses a Function Compute domain name.

content

String

Yes

The address of the origin server. You can specify an IP address or a domain name.

port

Integer

No

The port that redirects requests to the origin server.

You can specify port 443, port 80, or a custom port. Default value: 80. If you specify port 443, Alibaba Cloud CDN communicates with the origin server over HTTPS.

priority

String

No

The priority of the origin server if multiple origin servers are specified.

Valid values: 20 and 30. Default value: 20. A value of 20 specifies that the origin server is the primary origin server. A value of 30 specifies that the origin server is a secondary origin server.

weight

String

No

The weight of the origin server if multiple origin servers are specified. You must specify a value that is smaller than 100. Default value: 10.

Response parameters

Parameter Type Example Description
RequestId String 15C66C7B-671A-4297-9187-2C4477247A74

The ID of the request.

Examples

Sample requests

http(s)://cdn.aliyuncs.com/?Action=AddCdnDomain
&CdnType=web
&DomainName=.example.com
&Sources=[{"content":"1.1.1.1","type":"ipaddr","priority":"20","port":80,"weight":"15"}]
&<Common request parameters>

Sample success responses

XML format 

<AddCdnDomainReesponse>
      <RequestId>15C66C7B-671A-4297-9187-2C4477247A74</RequestId>
</AddCdnDomainReesponse>

JSON format 

{ "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74" }

Error codes

HttpCode Error code Error message Description
400 InvalidDomainName.Malformed Specified DomainName is malformed. The error message returned because the value of the DomainName parameter is invalid.
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 set.
400 InvalidCdnType.Malformed Specified CdnType is malformed. The error message returned because the value of the CdnType parameter is invalid. Valid values: web (delivery of image and small files), download (delivery of large files), video (on-demand audio and video streaming), and liveStream (live streaming).
400 InvalidSources.Malformed Specified Sources is malformed. The error message returned because the format of the specified Sources parameter is invalid. You can set Sources to an IP address or a domain name. You can specify up to 20 IP addresses or one domain name. Separate IP addresses with commas (,). You cannot specify both IP addresses and domain names in the same call.
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 set.
400 InvalidSourceType.Malformed Specified CdnType is malformed. The error message returned because the format of the CdnType parameter is invalid.
400 InvalidScope.Malformed Specified Scope is malformed. The error message returned because the format of the Scope parameter is invalid.
400 SourceIp.Exceed The Certificate you provided is malformed! The error message returned because the format of the SSL certificate is invalid.
400 InvalidCertificate The Certificate you provided is malformed! The error message returned because the format of the SSL 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 name by using an Alibaba Cloud account that is not associated with an Aone ID (aoneId).
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 that start with the 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 support only the following workload types: web, download, and video.
400 InvalidResourceGroupId.Malformed Specified ResourceGroupId is malformed. The error message returned because the format of the 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 only top-level, second-level, and third-level domain names that are suffixed with alicdn.com.
400 InvalidTopLevelDomain.Malformed Specified TopLevelDomain is malformed. The error message returned because the value of the TopLevelDomain parameter is invalid.
400 TopLevelDomain.NotFound TopLevelDomain is not exist. The error message returned because the specified top-level domain name (TopLevelDomain) 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 supported by the resource group in the current state.
400 NotInternationRealIdentity You need to do real name authentication when you use Chinese mainland resources. The error message returned because you have not completed real-name verification that is required to use resources in mainland China. Based on the laws of the People's Republic of China (PRC), you must complete real-name verification before you can purchase information services in mainland China.
400 DomainOwnerVerifyFail Owner verification of the root domain failed. The error message returned because you must prove the ownership of the domain name. The first time a domain name is added to Alibaba Cloud CDN, you must prove the ownership by adding a DNS record or uploading a verification file.

For a list of error codes, visit the API Error Center.