AddDcdnIpaDomain - Edge Security Acceleration - Alibaba Cloud Documentation Center

Call the AddDcdnIpaDomain operation to add a domain name for IP Application Accelerator (IPA). You can add only one accelerated domain name at a time.

Operation description

Note

Before you add an accelerated domain name, you must activate the IPA service for DCDN.
The accelerated domain name must have a valid ICP filing.
If the content of the origin server is not stored on Alibaba Cloud, the content is subject to review. The review is completed within one business day.
The call frequency for a single user is limited to 10 calls per second.

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:AddDcdnIpaDomain

create

*IpaDomain

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

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The domain name that you want to add to DCDN for IPA. Wildcard domain names are supported. A wildcard domain name must start with a period (.), such as .example.com.	example.com
ResourceGroupId	string	No	The ID of the resource group. If you do not specify this parameter, the system automatically uses the ID of the default resource group.	rg
Sources	string	Yes	The list of origin addresses.	[{"content":"10.10.10.10","type":"ipaddr","priority":"20","port":80,"weight":"15"}]
CheckUrl	string	No	The health check URL.	example.com/image_01.png
Scope	string	No	The acceleration region. Valid values: domestic: the Chinese mainland only. overseas: global (excluding the Chinese mainland). global: global.	domestic
TopLevelDomain	string	No	The top-level domain.	*.com
Protocol	string	No	The name of the protocol. Valid values: udp: UDP. tcp: TCP. Note Example: `{"protocol":"udp"}`.	udp

Fields in Sources

Parameter	Type	Required	Description
type	String	Yes	The type of the origin server. `ipaddr`: IP address. `domain`: domain name. The `oss` type is not supported.
content	String	Yes	The origin URL, which can be an IP address or a domain name.
port	Integer	Yes	A custom port. Valid values: 0 to 65535.
priority	String	No	The priority of the origin server. Valid values: 20 and 30. Default value: 20. A value of 20 specifies a primary origin server. A value of 30 specifies a secondary origin server.
weight	String	No	The weight of the origin server for origin fetch. The value must be an integer less than 100. Default value: 10.

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	0AEDAF20-4DDF-4165-8750-47FF9C1929C9

Examples

Success response

JSON format

{
  "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9"
}

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	TopLevelDomain.NotFound	The specified TopLevelDomain does not exist.	The specified top-level domain name does not exist.
400	EntityNotExists.ResourceGroup	The resource group does not exist.	The specified resource group does not exist.
400	EntityNotExist.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	InvalidSource.Port.Malformed	The source port is empty, or it is outside the range 0-65535.	No port is specified or the specified port number is invalid. Valid values: 0 to 65535.
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	TopLevelDomain.Mismatch	The specified TopLevelDomain does not match webSiteType.	The top-level domain name does not match the domain name type.
400	DomainOverLimit	The maximum number of domains is exceeded.	The maximum number of domain names has been reached.
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.
403	DcdnIpaServiceNotFound	The DCDN IPA service has not been activated.	IPA is not activated for DCDN.
404	NoResource	The required port has no resources, please submit a ticket.	The required port has no resources, please submit a ticket.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.