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.
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 |
| Tag.N | No | Array of Tag | Tag configuration |
| Ipv6Access | No | Ipv6Access | IPv6 access configuration |
| OfflineCache | No | OfflineCache |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
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 parameter>{
"Response": {
"RequestId": "a4ac88a3-a159-47ac-9b87-19185d7deb09"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.CdnDbError | Internal data error. Please submit a ticket for troubleshooting. |
| InternalError.CdnSystemError | System error. Please submit a ticket for troubleshooting. |
| InvalidParameter.CamResourceBelongToDifferentUser | Inconsistent resource AppID. |
| InvalidParameter.CamResourceSixStageError | Incorrect six-segment resource parameter. |
| InvalidParameter.CamTagKeyAlreadyAttached | The domain name has already been associated with this tag. |
| 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 | The number of tag keys exceeds the upper limit. Each resource can have up to 50 tag keys. |
| LimitExceeded.CamTagKeyTooLong | The tag key length exceeds the upper limit. |
| LimitExceeded.CamTagKeyTooManyTagValue | The number of tag values exceeds the upper limit. Each tag key can have up to 1,000 tag values. |
| LimitExceeded.CamUserTooManyTagKey | The number of keys exceeds the upper limit. Each user can have up to 1,000 different keys. |
| LimitExceeded.CdnHostOpTooOften | Domain name operations are too frequent. |
| LimitExceeded.CdnUserTooManyHosts | The number of connected domain names has exceeded the upper 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.CdnHostExistsInTcb | The domain name has been connected in the TCB console. |
| 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.CdnHostExistsInInternal | The domain name already exists in the system. Please submit a ticket. |
| 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.CdnTagUnauthorized | The sub-account has no access to the tag. |
| 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 whitelist 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?