Overview
Menu

BindSharedCNAME

1. API Description

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

This API is used to bind/unbind a domain name to/from 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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: BindSharedCNAME.
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.
BindTypeYesStringAction type. Values:
  • bind: To bind
  • unbind: To unbind
  • BindSharedCNAMEMaps.NYesArray of BindSharedCNAMEMapBindings between domain names and a shared CNAME

    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 Binding with a shared CNAME

    In this example, we bind the domain names a.qq.com and b.qq.com under the site zone-225qgrnvbi9w to the shared CNAME qq.com.sai2ig51kaa5.share.dnse5.com, and bind the domain names api.qq.com and img.qq.com to the shared CNAME config.qq.com.sai2ig51kaa5.share.dnse5.com.

    Input Example

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: BindSharedCNAME
    <Common request parameters>
    
    {
        "ZoneId": "zone-225qgrnvbi9w",
        "BindType": "bind",
        "BindSharedCNAMEMaps": [
            {
                "SharedCNAME": "qq.com.sai2ig51kaa5.share.dnse5.com",
                "DomainNames": [
                    "a.qq.com",
                    "b.qq.com"
                ]
            },
            {
                "SharedCNAME": "config.qq.com.sai2ig51kaa5.share.dnse5.com",
                "DomainNames": [
                    "api.qq.com",
                    "img.qq.com"
                ]
            }
        ]
    }
    

    Output Example

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

    Example2 Unbinding from a shared CNAME

    In this example, we unbind the domain name a.qq.com under the site zone-225qgrnvbi9w from the shared CNAME qq.com.sai2ig51kaa5.share.dnse5.com.

    Input Example

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: BindSharedCNAME
    <Common request parameters>
    
    {
        "ZoneId": "zone-225qgrnvbi9w",
        "BindType": "unbind",
        "BindSharedCNAMEMaps": [
            {
                "SharedCNAME": "qq.com.sai2ig51kaa5.share.dnse5.com",
                "DomainNames": [
                    "a.qq.com"
                ]
            }
        ]
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "5e0a2b4e-df6d-5d3a-ac39-1706cbf8a708"
        }
    }
    

    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
    ResourceInUseThe resource is occupied.
    ResourceNotFoundThe resource doesn’t exist.