AddCdnDomain

Last updated: 2020-02-10 11:21:13

PDF

1. API Description

Domain name for API request: cdn.tencentcloudapi.com.

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

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

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 Business type of acceleration domain name
web: static acceleration
download: download acceleration
media: streaming media VOD acceleration
Origin Yes Origin Origin server configuration
ProjectId No Integer Project ID, which is 0 by default, indicating Default Project
IpFilter No IpFilter IP blacklist/whitelist 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 origin-pull configuration
FollowRedirect No FollowRedirect 301/302 origin-pull follow-redirect configuration
ErrorPage No ErrorPage Error code redirect configuration (This feature is in beta test and not fully 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 test and not fully available yet.)
Ipv6 No Ipv6 Ipv6 configuration (This feature is in beta test and not fully available yet.)
SpecificConfig No SpecificConfig Specific configuration for region attributes
Applicable to use cases where the configuration of accelerating domain names inside mainland China is inconsistent with the configuration outside mainland China.
Area No String Domain name acceleration region
mainland: acceleration inside mainland China
overseas: acceleration outside mainland China
global: global acceleration
To use overseas acceleration and global acceleration, you need to enable the overseas acceleration service first

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

https://cdn.tencentcloudapi.com/?Action=AddCdnDomain
&Domain=www.test.com
&ServiceType=web
&ProjectId=0
&Area=mainland
&Origin.Origins.0=1.1.1.1
&Origin.OriginType=ip
&<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.

SDK

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
InternalError.CdnConfigError Failed to update the domain name configuration.
InternalError.CdnSystemError System error. Please submit a ticket for troubleshooting.
InvalidParameter.CdnInterfaceError Internal API error. Please submit a ticket for troubleshooting.
InvalidParameter.CdnParamError Parameter error. Please see the sample parameters in the documentation.
ResourceInUse.CdnHostExists Domain name already exists.
UnauthorizedOperation.CdnCamUnauthorized No CAM policy is configured for the sub-account.
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.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.