Adds a domain name to IPA. You can add only one domain name in each call.

Note
  • Make sure that you have activated the IPA service.
  • Make sure that you have completed Internet content provider (ICP) filling for the accelerated domain name.
  • If the content on 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 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 domain name 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 list of origin URLs.

ResourceGroupId String No rg-xxxxx

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

CheckUrl String No exanmple.com/123.jpeg

The URL that is used to test the availability of the origin server.

Scope String No domestic

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

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

The top-level domain name.

Fields in Sources

Field

Type

Required

Description

type

String

Yes

The type of origin server. Valid values: ipaddr and domain. A value of ipaddr specifies the IP address of the origin server. A value of domain specifies the domain name of the origin server. A value of oss is not supported.

content

String

Yes

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

port

Integer

Yes

The custom port number. 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 indicates a primary origin server. A value of 30 indicates a secondary origin server.

weight

String

No

The weight of the origin server. You must specify a value that is less than 100. The default value is 10.

Response parameters

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

The ID of the request.

Examples

Sample requests

http(s)://dcdn.aliyuncs.com/? Action=AddDcdnIpaDomain
&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

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

JSON format

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

Error codes

HttpCode Error code Error message Description
400 InvalidDomainName.Malformed The specified DomainName is invalid. The error message returned because the domain name format is invalid.
400 InvalidSource.Content.Malformed The specified Source Content is invalid. The error message returned because the specified value of the Sources parameter is invalid. Specify another value.
400 MissingSource.Content The Source Content must be specified. The error message returned because the content field in the Sources parameter is not specified. Specify the field and try again later.
400 MissingSource.Type The Source Type must be specified. The error message returned because the type field in the Sources parameter is not specified. Specify the field and try again later.
400 InvalidSource.Type.Malformed The specified Source Type is invalid. The error message returned because the specified value of the type field in the Sources parameter is invalid. Specify a value in the required format.
400 InvalidSource.Priority.Malformed The specified Source Priority is invalid. The error message returned because the specified value of the priority field in the Sources parameter is invalid. Specify a value in the required format.
400 InvalidScope.Malformed The specified Scope is invalid. The error message returned because the specified value of the Scope parameter is invalid. Specify a valid value and try again.
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 has been exceeded.
400 InvalidCertificate The specified certificate format is invalid. The error message returned because the format of the specified certificate is invalid. Specify a valid certificate and try again.
400 InvalidCertificate.TooLong The maximum length of the certificate is exceeded. The error message returned because the maximum length of the specified certificate content has been reached.
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. Specify valid origin information and try again.
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 that start with all. cannot exist at the same time.
400 CdnTypeNotSupportExtensiveDomain Wildcard domain names are not supported. The error message returned because wildcard domain names are not supported.
400 ExtensiveAndSpecificDomainConflict The wildcard domain name overlaps a domain name at the same level. The error message returned because the specified wildcard domain name is mutually exclusive with an existing domain name at the same level. Specify another domain name.
400 InvalidResourceGroupId.Malformed The specified ResourceGroupId is invalid. The error message returned because the specified value of the ResourceGroupId parameter is invalid. Specify a valid value.
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 name is used by another account. If you need to add the domain name, submit a ticket.
400 InvalidDomainNameLevel The alicdn.com domain supports a maximum of three levels of domain. The error message returned because the specified accelerated domain name is not supported. Alibaba Cloud DCDN supports up to three 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 supported while 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 real-name verification that is required to use resources in mainland China. Based on the laws of People's Republic of China (PRC), you must complete real-name verification before you purchase information services 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 number is not specified or the specified origin 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.
400 RecordCheckNotAvailable The ICP filing interface is unavailable. Please try again later. The error message returned because the interface for Internet content provider (ICP) filing is unavailable. Try again later.
400 IcpBlack The domain is on the ICP blacklist. The error message returned because the domain name is included in the ICP filing blacklist that is provided by the Ministry of Industry and Information Technology of the People's Republic of China.
400 IspBlack The domain is on the ISP blacklist. The error message returned because the domain name is included in the blacklist that is provided by Alibaba Cloud.

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