tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

AddCdnDomain

最后更新时间：2023-12-01 16:39:46

    1. API Description

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

    This API is used to add a CDN acceleration domain name. Up to 100 domain names can be added per minute.

    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 Params. The value used for this API: AddCdnDomain.
    Version Yes String Common Params. The value used for this API: 2018-06-06.
    Region No String Common Params. This parameter is not required for this API.
    Domain Yes String Domain name
    ServiceType Yes String Acceleration domain name service type
    web: Webpage file downloads
    download: Large file downloads
    media: Audio and video on demand acceleration
    hybrid: Dynamic and static content acceleration
    dynamic: Dynamic content acceleration
    Origin Yes Origin Origin server configuration
    ProjectId No Integer Project ID. Default value: 0, indicating Default Project
    IpFilter No IpFilter IP blocklist/allowlist
    IpFreqLimit No IpFreqLimit IP rate limiting
    StatusCodeCache No StatusCodeCache Status code cache
    Compression No Compression Smart compression
    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 redirection (in beta)
    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 validity configuration
    OriginPullOptimization No OriginPullOptimization Cross-MLC-border origin-pull optimization
    Https No Https HTTPS acceleration
    Authentication No Authentication Timestamp hotlink protection
    Seo No Seo SEO optimization
    ForceRedirect No ForceRedirect Force redirect by access protocol
    Referer No Referer Referer hotlink protection
    MaxAge No MaxAge Browser caching (in beta)
    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 Offline cache
    Quic No Quic QUIC access, which is a paid service. You can check the product document and Billing Overview for more information.
    AwsPrivateAccess No AwsPrivateAccess Access authentication for S3 origin
    OssPrivateAccess No OssPrivateAccess Access authentication for OSS origin
    HwPrivateAccess No HwPrivateAccess Origin-pull authentication for Huawei Cloud OBS origin
    QnPrivateAccess No QnPrivateAccess Origin-pull authentication for Qiniu Cloud Kodo origin
    OthersPrivateAccess No OthersPrivateAccess Origin-pull authentication for other origins
    HttpsBilling No HttpsBilling HTTPS (enabled by default), which is a paid service. You can check the product document and Billing Overview for more information.

    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

    This example shows you how to add an acceleration domain name.

    Input Example

    POST / HTTP/1.1
Host: cdn.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddCdnDomain
<Common request parameters>

{
    "Origin": {
        "OriginType": "ip",
        "Origins": [
            "1.1.1.1"
        ]
    },
    "ProjectId": "0",
    "Domain": "www.test.com",
    "ServiceType": "web",
    "Area": "mainland"
}

    Output Example

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

    5. Developer Resources

    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
    FailedOperation.CdnConfigError Failed to update the domain name configuration. Please submit a ticket for troubleshooting.
    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.
    InternalError.ProxyServer Internal service 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 characters in the tag key.
    InvalidParameter.CamTagKeyNotExist The tag key does not exist.
    InvalidParameter.CamTagValueIllegal Invalid characters in the tag value.
    InvalidParameter.CdnCertInfoNotFound The certificate information is invalid or does not exist. Please check and try again.
    InvalidParameter.CdnConfigInvalidHost Invalid domain name. Please make sure the domain name is valid.
    InvalidParameter.CdnConfigInvalidTag Invalid tag configuration.
    InvalidParameter.CdnConfigTagRequired Failed to add the domain name. Please make sure to specify a tag for the domain name.
    InvalidParameter.CdnHostInternalHost This domain name belongs to another account. You are not allowed o connect it to CDN.
    InvalidParameter.CdnHostIsCosDefaultAccess It is a COS origin domain name. Please go to the COS console to enable "Default CDN Acceleration Domain".
    InvalidParameter.CdnHostTooLongHost The domain name is too long.
    InvalidParameter.CdnInterfaceError Internal API error. Please submit a ticket for troubleshooting.
    InvalidParameter.CdnKeyRulesInvalidQueryStringValue Invalid field: QueryString. Please check and try again.
    InvalidParameter.CdnParamError Parameter error. Please see the sample parameters in the documentation.
    InvalidParameter.CdnStatTooManyDomains The number of queried domain names reached the limit.
    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.CamTagQuotaExceedLimit The number of bound tags exceeds the limit.
    LimitExceeded.CamUserTooManyTagKey The number of keys exceeds the upper limit. Each user can have up to 1,000 different keys.
    LimitExceeded.CdnConfigTooManyCacheRules The number of cache validity configuration rules exceeds the limit.
    LimitExceeded.CdnHostOpTooOften Domain name operations are too frequent.
    LimitExceeded.CdnUserTooManyHosts The number of domain names under the account has reached the upper limit. Please submit a ticket for assistance.
    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.CdnHostNotExists Unable to find the domain name. Please make sure the domain name is correct.
    ResourceNotFound.CdnUserNotExists The CDN service has not been activated. Please activate it first before using this API.
    ResourceUnavailable.CdnHostExistsInDsa The DSA feature is enabled for the domain name.
    ResourceUnavailable.CdnHostExistsInTcb The domain name has been connected in the TCB console.
    ResourceUnavailable.CdnHostIsMalicious The domain name is not compliant and cannot be connected.
    ResourceUnavailable.CdnHostNoIcp ICP filing is required for the domain name and the synchronization takes 2 hours. If it is already filed, please try later.
    ResourceUnavailable.HostExistInVod The domain name has been connected to VOD. To access CDN, please delete it from VOD first.
    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.CdnHostInIcpBlacklist The domain name is not compliant and cannot be connected.
    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.CdnUserIsIsolated The account has been isolated due to arrears. Please pay the bill and try again.
    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.
    UnauthorizedOperation.OperationTooOften Too many calling attempts.
    UnsupportedOperation.OpNoAuth This operation is not supported currently. Please submit a ticket for assistance.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款