Last updated: 2020-09-17 18:03:19

1. API Description

Domain name for API request:

This API is used to add a CDN acceleration domain name.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: AddCdnDomain.
Version Yes String Common parameter. The value used for this API: 2018-06-06.
Region No String Common parameter. This parameter is not required for this API.
Domain Yes String Domain name
ServiceType Yes String Acceleration domain name service type
web: static acceleration
download: download acceleration
media: streaming media VOD acceleration
Origin Yes Origin Origin server configuration
ProjectId No Integer Project ID. Default value: 0, indicating Default Project
IpFilter No IpFilter IP blocklist/allowlist configuration
IpFreqLimit No IpFreqLimit IP access limit configuration
StatusCodeCache No StatusCodeCache Status code cache configuration
Compression No Compression Smart compression configuration
BandwidthAlert No BandwidthAlert Bandwidth cap configuration
RangeOriginPull No RangeOriginPull Range GETs configuration
FollowRedirect No FollowRedirect 301/302 origin-pull follow-redirect configuration
ErrorPage No ErrorPage Error code redirect configuration (This feature is in beta and not generally available yet.)
RequestHeader No RequestHeader Request header configuration
ResponseHeader No ResponseHeader Response header configuration
DownstreamCapping No DownstreamCapping Download speed configuration
CacheKey No CacheKey Node cache key configuration
ResponseHeaderCache No ResponseHeaderCache Header cache configuration
VideoSeek No VideoSeek Video dragging configuration
Cache No Cache Cache expiration time configuration
OriginPullOptimization No OriginPullOptimization Cross-border linkage optimization configuration
Https No Https HTTPS acceleration configuration
Authentication No Authentication Timestamp hotlink protection configuration
Seo No Seo SEO configuration
ForceRedirect No ForceRedirect Access protocol forced redirect configuration
Referer No Referer Referer hotlink protection configuration
MaxAge No MaxAge Browser cache configuration (This feature is in beta and not generally available yet.)
Ipv6 No Ipv6 IPv6 configuration (This feature is in beta and not generally available yet.)
SpecificConfig No SpecificConfig Specific region configuration
Applicable to cases where the acceleration domain name configuration differs for regions in and outside mainland China.
Area No String Domain name acceleration region
mainland: acceleration inside mainland China
overseas: acceleration outside mainland China
global: global acceleration
Overseas acceleration service must be enabled to use overseas acceleration and global acceleration.
OriginPullTimeout No OriginPullTimeout Origin-pull timeout configuration

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Adding an acceleration domain name

Input Example
&<Common request parameters>

Output Example

  "Response": {
    "RequestId": "a4ac88a3-a159-47ac-9b87-19185d7deb09"

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.


TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.CdnConfigError Failed to update the domain name configuration. Please try again or contact customer service.
InternalError.CdnConfigError Failed to update the domain name configuration.
InternalError.CdnSystemError System error. Please submit a ticket for troubleshooting.
InvalidParameter.CamResourceBelongToDifferentUser The resource AppId values in the same request do not match.
InvalidParameter.CamResourceSixStageError Incorrect six-segment resource parameter.
InvalidParameter.CamTagKeyAlreadyAttached The domain name has already been associated with this tag. Do not repeat the operation.
InvalidParameter.CamTagKeyIllegal Invalid tag key character.
InvalidParameter.CamTagKeyNotExist The tag key does not exist.
InvalidParameter.CamTagValueIllegal Invalid tag value character.
InvalidParameter.CdnConfigInvalidHost The domain name is invalid.
InvalidParameter.CdnConfigInvalidTag Invalid tag configuration.
InvalidParameter.CdnConfigTagRequired Failed to add the domain name. You must select a tag for the current domain name. Please check and try again.
InvalidParameter.CdnHostInternalHost Internal domain names cannot be connected.
InvalidParameter.CdnInterfaceError Internal API error. Please submit a ticket for troubleshooting.
InvalidParameter.CdnParamError Parameter error. Please see the sample parameters in the documentation.
LimitExceeded.CamResourceArrayTooLong The number of resource arrays exceeds the upper limit.
LimitExceeded.CamResourceTooManyTagKey Up to 50 tag keys are supported for one single resource.
LimitExceeded.CamTagKeyTooLong The tag key length exceeds the upper limit.
LimitExceeded.CamTagKeyTooManyTagValue Up to 1,000 tag values are supported for one single tag key.
LimitExceeded.CamUserTooManyTagKey Up to 1,000 different keys are supported for one single user.
LimitExceeded.CdnHostOpTooOften Domain name operations are too frequent.
LimitExceeded.CdnUserTooManyHosts The number of connected domain names exceeded the limit.
ResourceInUse.CdnConflictHostExists The domain name conflicts with an existing domain name in the system.
ResourceInUse.CdnHostExists Domain name already exists.
ResourceInUse.CdnOpInProgress CDN resources are being operated.
ResourceNotFound.CamTagKeyNotExist The tag key does not exist.
ResourceNotFound.CamTagNotExist The tag does not exist.
ResourceNotFound.CdnUserNotExists The CDN service has not been activated. Please activate it first before using this API.
ResourceUnavailable.CdnHostNoIcp The domain name does not have an ICP filing.
UnauthorizedOperation.CdnCamUnauthorized No CAM policy is configured for the sub-account.
UnauthorizedOperation.CdnDomainRecordNotVerified The domain name has not been verified.
UnauthorizedOperation.CdnHostIsOwnedByOther This domain name belongs to another account, and you do not have permission to connect it.
UnauthorizedOperation.CdnHostIsUsedByOther The domain name has been connected by another account. For more information, please submit a ticket.
UnauthorizedOperation.CdnHostUnauthorized The sub-account has no access to the CDN-accelerated domain name.
UnauthorizedOperation.CdnUserAuthFail Fail to authenticate the CDN user.
UnauthorizedOperation.CdnUserAuthWait The CDN user is pending authentication.
UnauthorizedOperation.CdnUserIsSuspended The CDN service has been suspended. Please restart it and try again.
UnauthorizedOperation.CdnUserNoWhitelist You are not in the beta allowlist and thus have no permission to use this function.
UnauthorizedOperation.OpNoAuth This operation is not supported currently. Please submit a ticket for assistance.
UnsupportedOperation.OpNoAuth This operation is not supported currently. Please submit a ticket for assistance.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback