1. 接口描述
接口请求域名： teo.tencentcloudapi.com 。
用于创建共享 CNAME，该功能白名单内测中。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateSharedCNAME。 |
| Version | 是 | String | 公共参数，本接口取值：2022-09-01。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| ZoneId | 是 | String | 共享 CNAME 所属站点的 ID。 |
| SharedCNAMEPrefix | 是 | String | 共享 CNAME 前缀。请输入合法的域名前缀，例如"test-api"、"test-api.com"，限制输入 50 个字符。 共享 CNAME 完整格式为： <自定义前缀>+<zoneid中的12位随机字符串>+share.dnse[0-5].com。例如前缀传入 example.com，EO 会为您创建共享 CNAME：example.com.sai2ig51kaa5.share.dnse2.com。 |
| Description | 否 | String | 描述。可输入 1-50 个任意字符。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| SharedCNAME | String | 共享 CNAME。格式为：<自定义前缀>+<ZoneId中的12位随机字符串>+share.dnse[0-5].com。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建共享 CNAME
在 ZoneId 为 zone-225qgrnvbi9w 的站点下，创建一个共享 CNAME 前缀为 test，描述为 For Service A 的共享 CNAME。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateSharedCNAME
<公共请求参数>
{
"SharedCNAMEPrefix": "test",
"ZoneId": "zone-225qgrnvbi9w",
"Description": "For Service A"
}输出示例
{
"Response": {
"SharedCNAME": "test.225qgrnvbi9w.share.dnse1.com",
"RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.NotAllowedWildcardSharedCNAME | 不支持接入泛域名 CNAME |
| InvalidParameterValue.SharedCNAMEPrefixNotMatch | 请输入合法的共享 CNAME 前缀，最大支持50个字符。 |
| LimitExceeded | 超过配额限制。 |
| OperationDenied.ErrZoneIsAlreadyPaused | 站点处于停用状态，请开启后重试。 |
| ResourceUnavailable.SharedCNAMEAlreadyExists | 该共享 CNAME 已被占用，请重新输入。 |