You can call this operation to add a domain name to IP Application Accelerator (IPA) as an accelerated domain. You can add only one domain in one request.

When you call this operation, follow these rules:
  • Make sure that you have activated the IPA service.
  • 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 request.

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 AddDcdnIpaDomain

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

DomainName String Yes example.com

The name of the domain to be added to IPA. Wildcard domain names are supported. A wildcard domain name must start with a period (.). Example: .example.com

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

The origin information.

CheckUrl String No yourCheckUrl

The URL to test the availability of the origin.

ResourceGroupId String No 123

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

Scope String No domestic

The region where your acceleration service is deployed. Valid values:

  • domestic: mainland China
  • overseas: outside mainland China
  • global: all countries in the world
TopLevelDomain String No yourTopLevelDomain.com

The top-level domain name.

Fields in Sources

Field

Type

Required

Description

type

String

Yes

The type of the origin. Valid values: ipaddr and domain, which specify the IP address and domain name of the origin, respectively. A value of oss is not supported.

content

String

Yes

The origin address, which can be an IP address or a domain name.

port

Integer

Yes

The port number. Valid values: 0 to 65535.

priority

String

No

The priority of the origin if multiple origins are specified. Valid values: 20 and 30. Default value: 20. A value of 20 specifies that the origin is a primary origin, and a value of 30 specifies that the origin is a secondary origin.

weight

String

No

The weight of the origin if multiple origins are specified. The value must be less than 100. Default value: 10.

Response parameters

Parameter Type Example Description
RequestId String 0AEDAF20-4DDF-4165-8750-47FF9C1929C9

The ID of the request.

Examples

Sample requests

http://dcdn.aliyuncs.com?Action=AddDcdnIpaDomain
&DomainName=example.com
&Sources=[{"content":"1.1.1.1","type":"ipaddr","priority":"20","port":80}]
&<Common request parameters>

Sample success responses

XML format

<AddDcdnIpaDomainResponse>
	  <RequestId>0AEDAF20-4DDF-4165-8750-47FF9C1929C9</RequestId>
</AddDcdnIpaDomainResponse>

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 error message returned because the specified DomainName parameter is invalid.
400 InvalidSource.Content.Malformed The specified Source Content is invalid. The error message returned because the content field specified in the Sources parameter is invalid.
400 MissingSource.Content The Source Content must be specified. The error message returned because the content field in the Sources parameter must be specified.
400 MissingSource.Type The Source Type must be specified. The error message returned because the type field in the Sources parameter must be specified.
400 InvalidSource.Type.Malformed The specified Source Type is invalid. The error message returned because the type field specified in the Sources parameter is invalid.
400 InvalidSource.Priority.Malformed The specified Source Priority is invalid. The error message returned because the priority field specified in the Sources parameter is invalid.
400 InvalidScope.Malformed The specified Scope is invalid. The error message returned because the specified Scope parameter is invalid.
400 SourceIp.Exceed The maximum number of back-to-origin IP addresses is exceeded. The error message returned because the maximum number of origin IP addresses is exceeded.
400 InvalidCertificate The specified certificate format is invalid. The error message returned because the specified certificate is invalid.
400 InvalidCertificate.TooLong The maximum length of the certificate is exceeded. The error message returned because the length of the specified certificate exceeds the upper limit.
400 CheckSourceHealthFailed Error checking the security. Provide the valid origin site information. The error message returned because the specified origin information has failed the security check.
400 ExtensiveAndAllBothExist A wildcard domain name and a domain name with an all. prefix cannot be both specified. The error message returned because wildcard domain names and domain names starting with the string "all." cannot exist at the same time.
400 CdnTypeNotSupportExtensiveDomain Wildcard domain names are not supported. The error message returned because wildcard domains are not supported.
400 ExtensiveAndSpecificDomainConflict The wildcard domain name overlaps a domain name at the same level. 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 InvalidResourceGroupId.Malformed The specified ResourceGroupId is invalid. The error message returned because the specified ResourceGroupId parameter is invalid.
400 DomainReserved The root domain of your domain is reserved by another account. Submit a ticket to contact customer support. The error message returned because the root domain of the specified domain is used by another account. If you still want to add the domain, submit a ticket.
400 InvalidDomainNameLevel The alicdn.com domain supports a maximum of three levels of domain. The error message returned because the specified domain is not supported. IPA supports up to four levels in an accelerated domain name.
400 TopLevelDomain.NotFound The specified TopLevelDomain does not exist. The error message returned because the specified top-level domain name 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 The current status of the resource group does not support this operation. The error message returned because the operation is not allowed when the resource group is in the current state.
400 NotInternationRealIdentity Real-name registration is required for services offered in Mainland China. The error message returned because you have not completed the real-name authentication that is required to use resources in mainland China.
400 InvalidSource.Port.Malformed The source port is empty, or it is outside the range 0-65535. The error message returned because the origin port is not specified or the specified port number is invalid. Valid port numbers are from 0 to 65535.
403 DcdnIpaServiceNotFound The DCDN IPA service has not been activated. The error message returned because the IPA service is not activated.

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