tencent cloud

APIs

ModifySharedCNAME

Focus Mode
Font Size
Last updated: 2026-04-13 14:46:36

1. API Description

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

This API is used to modify a shared CNAME. Currently only support modifying the description of a shared CNAME and setting the associated IP SSL domain name of a shared CNAME with IP SSL type. The shared CNAME itself cannot be modified after creation. This feature is in beta test.

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: ModifySharedCNAME.
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 Shared CNAME associated site ID.
SharedCNAME Yes String Shared CNAME.
Description No String Enter the adjusted description.
IPSSLSetting No IPSSLSetting Set the IP SSL message of the shared CNAME with IP SSL type.

3. Output Parameters

Parameter Name Type Description
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 Shared CNAME IP Binding SSL

Input Example

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

{
    "ZoneId": "zone-3njjbwxjh9uh",
    "SharedCNAME": "qwde31a.3njjbwxjh9uh.share.eodev-ov.com",
"Description": "Used for shared CNAME IP binding SSL"
    "IPSSLSetting": {
        "Operation": "bind",
        "AssociatedDomain": "oshare1.more.top"
    }
}

Output Example

{
    "Response": {
        "RequestId": "d5975d48-af10-4ceb-b730-1f00e41463f5"
    }
}

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
InternalError Internal error.
OperationDenied.DomainMustInIPSSLSharedCNAMEZoneAndInSharedCNAME Domain name must be in associated site of shared CNAME IP SSL and must be in shared CNAME IP SSL
OperationDenied.IPSSLAlreadyBoundAnotherDomain The IP SSL is bound to other domains. No operations allowed.
OperationDenied.LastIPSSLOperationNotComplete The domain name associated with the last IP SSL operation is not yet launched. Please wait for launch completion after proceeding.
ResourceNotFound The resource doesn’t exist.

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback