AddDcdnDomain-阿里云帮助中心

To add a domain name, call the AddDcdnDomain operation.

Operation description

You must activate the DCDN service before you add a domain name. For more information, see OpenDcdnService.
If the acceleration region is set to Chinese mainland only or Global, the accelerated domain must have an ICP filing.
The first time you add a domain name to Alibaba Cloud DCDN, you must complete domain ownership verification. For more information, see VerifyDcdnDomainOwner.
You can add only one accelerated domain at a time. By default, each user can add up to 50 domain names. To add more, request a quota increase in Quota Center.
This operation is limited to 100 calls per user per hour.

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

dcdn:AddDcdnDomain

create

*Domain

acs:dcdn:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The domain name to be accelerated. You can add only one domain name per request. Wildcard domains are supported. A wildcard domain must start with a period (.), for example, `.example.com`.	example.com
ResourceGroupId	string	No	The ID of the resource group. If you omit this parameter, the system uses the ID of the default resource group.	rg-acfmyuji4b6r4**
Sources	string	No	The list of sources.	[{"content":"10.10.10.10","type":"ipaddr","priority":"20","port":80}]
CheckUrl	string	No	The health check URL.	www.example.com/test.html
Scope	string	No	The service scope. Valid values: domestic: Chinese mainland. overseas: Regions outside the Chinese mainland. global: Global. Default value: domestic.	domestic
TopLevelDomain	string	No	The top-level domain.	yourTopLevelDomain
Tag	array<object>	No	The tags to add to the domain. You can add up to 20 tags.
	object	No
Key	string	No	The tag key.	env
Value	string	No	The tag value.	value
FunctionType	string	No	The computing service type. Valid values: routine: Routine. image: Image. cloudFunction: Cloud function.	routine

The following table describes the fields in Sources.

Parameter	Type	Required	Description
type	String	Yes	The origin type. Valid values: `ipaddr` (IP origin), `domain` (domain origin), and `oss` (OSS Bucket).
content	String	Yes	The origin address. This can be an IP address or a domain name.
port	Integer	No	The origin fetch port. Can be 80 (default), 443 (for HTTPS), or a custom port.
priority	String	No	The priority of the origin. Set to `20` for a primary origin (default) or `30` for a backup origin.
weight	String	No	The origin weight. A value from 1 to 100. The default is `10`.

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	15C66C7B-671A-4297-9187-2C4477247A74

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDomainName.Malformed	The specified DomainName is invalid.	The specified domain name is invalid.
400	InvalidSource.Content.Malformed	The specified Source Content is invalid.	The information about the origin server is invalid.
400	MissingSource.Content	The Source Content must be specified.	No value is specified for the content field in the Sources parameter.
400	MissingSource.Type	The Source Type must be specified.	No value is specified for the type field in the Sources parameter.
400	InvalidSource.Type.Malformed	The specified Source Type is invalid.	The value specified for the type field in the Sources parameter is invalid.
400	InvalidSource.Priority.Malformed	The specified Source Priority is invalid.	The value specified for the priority field in the Sources parameter is invalid.
400	InvalidScope.Malformed	The specified Scope is invalid.	The value specified for the Scope parameter is invalid.
400	SourceIp.Exceed	The maximum number of back-to-origin IP addresses is exceeded.	The number of origin IP addresses exceeds the upper limit.
400	InvalidCertificate	The specified certificate format is invalid.	The format of the specified certificate is invalid.
400	InvalidCertificate.TooLong	The maximum length of the certificate is exceeded.	The maximum length of the specified certificate content has been reached.
400	CheckSourceHealthFailed	Error checking the security. Provide the valid origin site information.	The origin check failed. Please provide the correct origin information.
400	ExtensiveAndAllBothExist	A wildcard domain name and a domain name with an all. prefix cannot be both specified.	Wildcard domain names and domain names that start with "all." cannot both exist.
400	CdnTypeNotSupportExtensiveDomain	Wildcard domain names are not supported.	Wildcard domain names are not supported.
400	ExtensiveAndSpecificDomainConflict	The wildcard domain name overlaps a domain name at the same level.	Wildcard domain names and specific domain names of the same level as the wildcard domain names are mutually exclusive. Enter another domain name.
400	InvalidResourceGroupId.Malformed	The specified ResourceGroupId is invalid.	The value specified for the ResourceGroupId parameter is invalid. Specify a valid value and try again.
400	DomainReserved	The root domain of your domain is reserved by another account. Submit a ticket to contact customer support.	The root domain name of this domain name is used by another account. Submit a ticket to apply for new domain names.
400	InvalidDomainNameLevel	The alicdn.com domain supports a maximum of three levels of domain.	alicdn.com supports up to three domain levels for wildcard domain names.
400	EntityNotExists.ResourceGroup	The resource group does not exist.	The specified resource group does not exist.
400	InvalidStatus.ResourceGroup	The current status of the resource group does not support this operation.	This operation is not supported while the resource group is in the current state.
400	NotInternationRealIdentity	Real-name registration is required for services offered in Mainland China.	You have not passed real-name verification. According to the regulations issued by MIIT, you must pass real-name verification if you want to purchase information services in the Chinese mainland.
400	TopLevelDomain.NotFound	The specified TopLevelDomain does not exist.	The specified top-level domain name does not exist.
400	RecordCheckNotAvailable	The ICP filing interface is unavailable. Please try again later.	The operation for ICP filing is unavailable. Try again later.
400	IcpBlack	The domain is on the ICP blacklist.	The domain name is on the blacklist of the MIIT.
400	IspBlack	The domain is on the ISP blacklist.	The domain name is on the blacklist of Alibaba Cloud.
400	InvalidCheckUrl.Malformed	The specified CheckUrl is invalid.	The CheckUrl parameter is set to an invalid value.
400	DomainOwnerVerifyFail	Owner verification of the root domain failed.	The first time a domain name is added to DCDN, you must prove the ownership of the domain name. You must add a DNS record or upload a verification file for the domain name before it can be added to DCDN.
400	TopLevelDomain.Mismatch	The specified TopLevelDomain does not match webSiteType.	The top-level domain name does not match the domain name type.
400	DomainInBlacklist	The domain is in the blacklist.	The domain name is in the blacklist.
400	DomainOverLimit	The maximum number of domains is exceeded.	The maximum number of domain names has been reached.
400	SourceInBlacklist	Source is in the blacklist.	The origin server is in the blacklist.
400	InvalidTagKey	The key should not be null, start with "acs:" or "aliyun", contain "http://" or "https://" or have special symbols:.!@#$%?/^&*)(+={}[]",'<>~·`?;.
400	InvalidTagValue	The tag value cannot contain these special symbols:http://, https://
400	ReservedTagKey	The tag key is used internally as a reserved field and is not allowed to be used.
400	InvalidFunctionType.Malformed	The specified FunctionType is invalid.
400	InvalidfunctionType.Malformed	FunctionType is malformed.
400	DomainInRiskList	The domain you added may be at risk. If you have any questions, please submit a ticket.	The domain name you added may be at risk. If you have any questions, please submit a work order.
400	RegionNoResource	Resource allocation failed. Please submit a work order to contact customer service.	Resource allocation failed. Please submit a work order to contact customer service.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.