EdgeOne Logo


1. API Description

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

This API is used to create an alias 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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: CreateAliasDomain.
VersionYesStringCommon Params. The value used for this API: 2022-09-01.
RegionNoStringCommon Params. This parameter is not required.
ZoneIdYesStringThe site ID.
AliasNameYesStringThe alias domain name.
TargetNameYesStringThe target domain name.
CertTypeNoStringCertificate configuration. Values:
  • none: (Default) Do not configure
  • hosting: Managed SSL certificate
  • CertId.NNoArray of StringThe certificate ID. This field is required when CertType=hosting.

    3. Output Parameters

    Parameter NameTypeDescription
    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 alias domain name

    Input Example

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateAliasDomain
    <Common request parameters>
        "TargetName": "aaa.example.com",
        "AliasName": "bbb.test.com",
        "CertType": "none",
        "ZoneId": "zone-28569s6od5na"

    Output Example

        "Response": {
            "RequestId": "4dcgtb24-7dc5-46s2-9q3e-95825d53dcs3a"

    5. Developer Resources


    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.
    FailedOperation.CertificateNotFoundThe certificate does not exist.
    InternalErrorInternal error.
    InternalError.ConfigLockedThe configuration is locked. Please unlock and try again.
    InvalidParameter.AliasDomainNotSupportSMCertChinese SM certificates are not supported for alias domain names.
    InvalidParameter.CertNotMatchDomainMismatch between the HTTPS certificate and the domain name.
    InvalidParameter.InvalidHttpsCertInfoInvalid HTTPS certificate.
    InvalidParameter.InvalidParameterInvalid parameter.
    InvalidParameter.InvalidRequestHeaderNameInvalid request header.
    InvalidParameterValueInvalid parameter value.
    InvalidParameterValue.InvalidAliasDomainNameThe alias domain name is invalid. It must contain numerics, English characters, and hyphens, but hyphen is not allowed at the beginning or the end.
    InvalidParameterValue.InvalidAliasNameSuffixInvalid alias domain suffix. This domain is for internal usage and cannot be used as the alias domain.
    LimitExceededThe quota limit has been reached.
    OperationDeniedOperation denied.
    OperationDenied.ConfigLockedThe configuration is locked. Please unlock and try again.
    OperationDenied.DomainIsBlockedUnable to use the domain name when it’s blocked.
    OperationDenied.DomainNoICPThe domain name doesn't have an ICP filing number.
    OperationDenied.VersionControlLockedThe operation is not allowed because the version management mode is applied.
    ResourceInUse.AliasNameThe alias domain name already exists.
    ResourceInUse.DuplicateNameDuplicate alias domain names.
    ResourceInUse.ZoneThe alias domain name is already added.
    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.
    UnauthorizedOperationUnauthorized operation.
    UnauthorizedOperation.CamUnauthorizedCAM is not authorized.
    UnsupportedOperation.TargetNameOriginTypeCosThe origin type of the target domain cannot be COS for an alias domain.