Overview
Menu

CreateAccelerationDomain

1. API Description

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

This API is used to create an acceleration domain name.

For sites connected via the CNAME, if you have not verified the ownership of the domain name, the ownership verification information of the domain name is returned. To verify your ownership of the domain name, see Ownership Verification.

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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: CreateAccelerationDomain.
VersionYesStringCommon Params. The value used for this API: 2022-09-01.
RegionNoStringCommon Params. This parameter is not required.
ZoneIdYesStringID of the site related with the acceleration domain name.
DomainNameYesStringAcceleration domain name
OriginInfoYesOriginInfoDetails of the origin.
OriginProtocolNoStringOrigin-pull protocol configuration. Values:
  • FOLLOW: Follow the protocol of origin
  • HTTP: Send requests to the origin over HTTP
  • HTTPS: Send requests to the origin over HTTPS
  • Default: FOLLOW
  • HttpOriginPortNoIntegerPorts for HTTP origin-pull requests. Range: 1-65535. It takes effect when OriginProtocol=FOLLOW/HTTP. Port 80 is used if it's not specified.
    HttpsOriginPortNoIntegerPorts for HTTPS origin-pull requests. Range: 1-65535. It takes effect when OriginProtocol=FOLLOW/HTTPS. Port 443 is used if it's not specified.
    IPv6StatusNoStringIPv6 status. Values:
  • follow: Follow the IPv6 configuration of the site
  • on: Enable
  • off: Disable
  • Default: follow
  • 3. Output Parameters

    Parameter NameTypeDescription
    OwnershipVerificationOwnershipVerificationUse the information returned by this parameter to verify the ownership of a domain name. For details, see Ownership Verification.
    Note: This field may return·null, indicating that no valid values can be obtained.
    RequestIdStringThe unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Creating an acceleration domain name for a domain-name origin server

    This example shows you how to create an acceleration domain name for a domain-name origin server.

    Input Example

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateAccelerationDomain
    <Common request parameters>
    
    {
        "ZoneId": "zone-225qgrnvbi9w",
        "DomainName": "qq.com",
        "OriginInfo": {
            "OriginType": "ip_domain",
            "Origin": "www.test.com"
        }
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707"
        }
    }
    

    Example2 Creating an acceleration domain name for an AWS S3 origin server

    This example shows you how to create an acceleration domain name for an AWS S3 origin server, with private network access enabled and authentication algorithm set to AWS Signature Version 2.

    Input Example

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateAccelerationDomain
    <Common request parameters>
    
    {
        "ZoneId": "zone-225qgrnvbi9w",
        "DomainName": "qq.com",
        "OriginInfo": {
            "OriginType": "AWS_S3",
            "Origin": "test.s3.ap-east-1.amazonaws.com",
            "PrivateAccess": "on",
            "PrivateParameters": [
                {
                    "Name": "AccessKeyId",
                    "Value": "AKIDdDva7VjFk7LQJ0X5WnbKE7mQTest"
                },
                {
                    "Name": "SecretAccessKey",
                    "Value": "nMirpdWhhT6bxPsaFwYM1SzQrTest"
                },
                {
                    "Name": "SignatureVersion",
                    "Value": "v2"
                },
                {
                    "Name": "Region",
                    "Value": "ap-east-1"
                }
            ]
        }
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a703"
        }
    }
    

    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 CodeDescription
    FailedOperationOperation failed.
    InternalError.ConfigLockedThe configuration is locked. Please unlock and try again.
    InvalidParameter.ConflictHostOriginThe origin cannot be the same as the domain name.
    InvalidParameter.ErrInvalidActionParamInvalid operation: Invalid parameter.
    InvalidParameter.InvalidAccelerateTypeParameter error.
    InvalidParameter.InvalidAwsPrivateAccessInvalid third-party object storage.
    InvalidParameter.InvalidAwsRegionInvalid region. Please fill in a correct region of the third-party object storage service.
    InvalidParameter.InvalidClientIpOriginInvalid origin for region-specific origin-pull.
    InvalidParameter.InvalidIpv6SwitchInvalid IPv6 settings.
    InvalidParameter.InvalidOriginInvalid origin server.
    InvalidParameter.InvalidOriginIpThe origin cannot be a private IP or loopback address.
    InvalidParameter.InvalidPrivateAccessParamsAccessKeyId and SecretAccessKey are required to access the third-party object storage.
    InvalidParameter.InvalidPrivateAccessSwitchThe value of PrivateAccess should be on or off.
    InvalidParameter.InvalidQuicBillingThe plan does not support QUIC.
    InvalidParameter.InvalidServerNameInvalid origin domain.
    InvalidParameter.InvalidStandardDebugClientIpInvalid client IP or CIDR block.
    InvalidParameter.InvalidWebSocketTimeoutInvalid WebSocket.
    InvalidParameter.PostMaxSizeLimitExceededMaximum upload size exceeded.
    InvalidParameter.SpaceNotBindOriginShield Space is not bound with an origin.
    InvalidParameter.ZoneIsGrayPublishingThe site is being upgraded. Changing is not supported. Please try again later.
    InvalidParameterValue.ConflictRecordIt conflicts with existing records.
    InvalidParameterValue.ConflictWithDNSSECDNS records conflict with DNSSEC.
    InvalidParameterValue.ConflictWithNSRecordThis DNS record conflicts with NS records.
    InvalidParameterValue.ContentSameAsNameThe host record cannot be the same as the record value.
    InvalidParameterValue.DomainNotMatchZoneThe specified domain name does not match the site.
    InvalidParameterValue.InvalidDNSContentIncorrect DNS record.
    InvalidParameterValue.InvalidDNSNameIncorrect DNS record name.
    InvalidParameterValue.InvalidDomainNameInvalid accelerated domain name. It can contain [0-9], [A-Z], [a-z] and [-]. It cannot start or end with "-".
    InvalidParameterValue.InvalidProxyOriginIncorrect DNS proxy
    InvalidParameterValue.OriginGroupNotExistsThe specified origin group does not exist.
    OperationDeniedOperation denied.
    OperationDenied.AccelerateMainlandDisableCross-MLC-border acceleration is in beta. To join the beta, submit a ticket.
    OperationDenied.ConfigLockedThe configuration is locked. Please unlock and try again.
    OperationDenied.DisableZoneNotCompletedThe EdgeOne service of the site is being disabled. Please try again later.
    OperationDenied.DomainNoICPThe domain name doesn't have an ICP filing number.
    OperationDenied.ErrZoneIsAlreadyPausedThe EdgeOne service of the site is disabled. Please enable it and try again.
    OperationDenied.InvalidAdvancedDefenseZoneAreaThe acceleration regions of the site must be in the Chinese mainland when you enable the DDoS Protection.
    OperationDenied.LoadBalanceStatusNotInOnlineThe affiliated Cloud Load Balancer is not in a running state. Operation is forbidden.
    OperationDenied.RecordIsForbiddenThe DNS record cannot be added.
    OperationDenied.ResourceLockedTemporaryThis operation conflicts with concurrent operations. Try again later.
    OperationDenied.VersionControlIsGrayingThere is a test version in use. Please release the test version to the live environment, or roll back the test version and try again.
    ResourceInUseThe resource is occupied.
    ResourceInUse.DnsRecordThe domain name is being resolved. If you need to enable acceleration, please go to DNS Records.
    ResourceNotFoundThe resource doesn’t exist.
    ResourceUnavailable.DomainAlreadyExistsThe domain name is already connected to EdgeOne by another account. Please retrieve it first in order to add it.
    ResourcesSoldOut.L7LackOfResources
    UnauthorizedOperation.CamUnauthorizedCAM is not authorized.
    UnauthorizedOperation.NoPermissionThe sub-account is not authorized for the operation. Please get permissions first.
    UnauthorizedOperation.UnknownAn unknown error occurred in the backend server.