BindSharedCNAME
1. API Description
Domain name for API request: teo.intl.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.
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: BindSharedCNAME. |
| 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 related with the acceleration domain name. |
| BindType | Yes | String | Action type. Values:bind: To bindunbind: To unbind |
| BindSharedCNAMEMaps.N | Yes | Array of BindSharedCNAMEMap | Bindings between domain names and a shared CNAME |
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 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.intl.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.intl.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.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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 |
|---|---|
| ResourceInUse | The resource is occupied. |
| ResourceNotFound | The resource doesn’t exist. |