All Products
Search
Document Center

Edge Security Acceleration:AddDcdnIpaDomain

Last Updated:Oct 17, 2024

Adds a domain name to IPA. You can specify only one domain name in each request.

Operation description

Note
  • Make sure that the IPA service is activated before you add a domain name to accelerate.

  • Make sure that the Internet content provider (ICP) filling is complete for the domain name to accelerate.

  • If the content on the origin server is not stored on Alibaba Cloud, the content must be reviewed. The review is complete by the end of the next business day after you submit the request.

  • You can call this operation up to 10 times per second per user.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The domain name to be added to IPA.

A wildcard domain that starts with a period (.) is supported, such as .example.com.

example.com
ResourceGroupIdstringNo

The ID of the resource group. If you do not specify a value for this parameter, the system automatically assigns the ID of the default resource group.

rg
SourcesstringYes

The information about the addresses of origin servers.

[{"content":"10.10.10.10","type":"ipaddr","priority":"20","port":80,"weight":"15"}]
CheckUrlstringNo

The URL that is used for health checks.

example.com/image_01.png
ScopestringNo

The acceleration region. Default value: domestic. Valid values:

  • domestic: Chinese mainland
  • overseas: outside the Chinese mainland
  • global: global
domestic
TopLevelDomainstringNo

The top-level domain.

*.com
ProtocolstringNo

The protocol. Valid values:

  • udp
  • tcp

**

Description For example: {"protocol":"udp"}.

udp

Fields in Sources

FieldTypeRequiredDescription
typeStringYesThe type of the 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.
contentStringYesThe address of the origin server. You can specify an IP address or a domain name.
portIntegerYesThe custom port number. Valid values: 0 to 65535.
priorityStringNoThe 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 is a primary origin. A value of 30 specifies that the origin is a secondary origin.
weightStringNoThe weight of the origin server if multiple origin servers are specified. You must specify a value that is less than 100. Default value: 10.

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

0AEDAF20-4DDF-4165-8750-47FF9C1929C9

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InvalidDomainName.MalformedThe specified DomainName is invalid.The specified domain name is invalid.
400InvalidSource.Content.MalformedThe specified Source Content is invalid.The information about the origin server is invalid.
400MissingSource.ContentThe Source Content must be specified.No value is specified for the content field in the Sources parameter.
400MissingSource.TypeThe Source Type must be specified.No value is specified for the type field in the Sources parameter.
400InvalidSource.Type.MalformedThe specified Source Type is invalid.The value specified for the type field in the Sources parameter is invalid.
400InvalidSource.Priority.MalformedThe specified Source Priority is invalid.The value specified for the priority field in the Sources parameter is invalid.
400InvalidScope.MalformedThe specified Scope is invalid.The value specified for the Scope parameter is invalid.
400SourceIp.ExceedThe maximum number of back-to-origin IP addresses is exceeded.The number of origin IP addresses exceeds the upper limit.
400InvalidCertificateThe specified certificate format is invalid.The format of the specified certificate is invalid.
400InvalidCertificate.TooLongThe maximum length of the certificate is exceeded.The maximum length of the specified certificate content has been reached.
400CheckSourceHealthFailedError checking the security. Provide the valid origin site information.Security check failed due to invalid information about the origin server.
400ExtensiveAndAllBothExistA 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.
400CdnTypeNotSupportExtensiveDomainWildcard domain names are not supported.Wildcard domain names are not supported.
400ExtensiveAndSpecificDomainConflictThe 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.
400InvalidResourceGroupId.MalformedThe specified ResourceGroupId is invalid.The value specified for the ResourceGroupId parameter is invalid. Specify a valid value and try again.
400DomainReservedThe 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.
400InvalidDomainNameLevelThe alicdn.com domain supports a maximum of three levels of domain.alicdn.com supports up to three domain levels for wildcard domain names.
400TopLevelDomain.NotFoundThe specified TopLevelDomain does not exist.The specified top-level domain name does not exist.
400EntityNotExists.ResourceGroupThe resource group does not exist.The specified resource group does not exist.
400EntityNotExist.ResourceGroupThe resource group does not exist.The specified resource group does not exist.
400InvalidStatus.ResourceGroupThe 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.
400NotInternationRealIdentityReal-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.
400InvalidSource.Port.MalformedThe 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.
400RecordCheckNotAvailableThe ICP filing interface is unavailable. Please try again later.The operation for ICP filing is unavailable. Try again later.
400IcpBlackThe domain is on the ICP blacklist.The domain name is on the blacklist of the MIIT.
400IspBlackThe domain is on the ISP blacklist.The domain name is on the blacklist of Alibaba Cloud.
400TopLevelDomain.MismatchThe specified TopLevelDomain does not match webSiteType.The top-level domain name does not match the domain name type.
400DomainOverLimitThe maximum number of domains is exceeded.The maximum number of domain names has been reached.
403DcdnIpaServiceNotFoundThe DCDN IPA service has not been activated.IPA is not activated for DCDN.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-09-03The Error code has changedView Change Details
2024-04-09The Error code has changedView Change Details