tencent cloud



Last updated: 2024-04-09 10:26:27

    1. API Description

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

    This API is used to create a shared CNAME. It is now only available to beta users.

    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: CreateSharedCNAME.
    Version Yes String Common Params. The value used for this API: 2022-09-01.
    Region No String Common Params. This parameter is not required.
    ZoneId Yes String ID of the site to which the shared CNAME belongs.
    SharedCNAMEPrefix Yes String Shared CNAME prefix. Enter a valid domain name prefix, such as "test-api" and "test-api.com". A maximum of 50 characters are allowed.

    Complete format of the shared CNAME: '+<A 12-character random string in ZoneId>+share.dnse[0-5].com'.

    For example, if the prefix is example.com, EdgeOne will create the shared CNAME: example.com.sai2ig51kaa5.share.dnse2.com.
    Description No String Description. It supports 1-50 characters.

    3. Output Parameters

    Parameter Name Type Description
    SharedCNAME String Shared CNAME. Format: '+<A 12-character random string in ZoneId>+share.dnse[0-5].com'.
    RequestId String The 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 a shared CNAME

    This example shows you how to create a shared CNAME under the site zone-225qgrnvbi9w with the prefix of test and description of For Service A.

    Input Example

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateSharedCNAME
    <Common request parameters>
        "SharedCNAMEPrefix": "test",
        "ZoneId": "zone-225qgrnvbi9w",
        "Description": "For Service A"

    Output Example

        "Response": {
            "SharedCNAME": "test.225qgrnvbi9w.share.dnse1.com",
            "RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707"

    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 Code Description
    InvalidParameterValue.NotAllowedWildcardSharedCNAME Wildcard domain CNAMEs are not supported.
    InvalidParameterValue.SharedCNAMEPrefixNotMatch Enter a valid shared CNAME prefix of up to 50 characters.
    LimitExceeded The quota limit has been reached.
    OperationDenied.ErrZoneIsAlreadyPaused The EdgeOne service of the site is disabled. Please enable it and try again.
    ResourceUnavailable.SharedCNAMEAlreadyExists The shared CNAME is used by others.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support