1. 接口描述
接口请求域名: teo.tencentcloudapi.com 。
创建别称域名。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateAliasDomain。 |
Version | 是 | String | 公共参数,本接口取值:2022-09-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
ZoneId | 是 | String | 站点 ID。 |
AliasName | 是 | String | 别称域名名称。 |
TargetName | 是 | String | 目标域名名称。 |
CertType | 否 | String | 证书配置,取值有: |
CertId.N | 否 | Array of String | 当 CertType 取值为 hosting 时需填入相应证书 ID。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建别称域名
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAliasDomain
<公共请求参数>
{
"TargetName": "aaa.example.com",
"AliasName": "bbb.test.com",
"CertType": "none",
"ZoneId": "zone-28569s6od5na"
}
输出示例
{
"Response": {
"RequestId": "4dcgtb24-7dc5-46s2-9q3e-95825d53dcs3a"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.CertificateNotFound | 边缘HTTPS证书不存在。 |
InternalError | 内部错误。 |
InternalError.ConfigLocked | 配置已被锁定,请解除配置锁定之后在重试。 |
InvalidParameter.AliasDomainNotSupportSMCert | 别称域名不支持配置国密证书。 |
InvalidParameter.CertNotMatchDomain | 无效的边缘HTTPS证书配置,证书与域名不匹配。 |
InvalidParameter.InvalidHttpsCertInfo | 无效的边缘HTTPS证书配置,证书内容无效。 |
InvalidParameter.InvalidParameter | 参数错误。 |
InvalidParameter.InvalidRequestHeaderName | 无效的请求头header。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.InvalidAliasDomainName | 别称域名名称不合法,别称域名应该由数字、英文字母、连词符组成,且连词符不能位于开头和结尾处。 |
InvalidParameterValue.InvalidAliasNameSuffix | 无效的别称域名后缀(该域名为内部接入域名,暂不支持作为别称域名接入)。 |
LimitExceeded | 超过配额限制。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.ConfigLocked | 配置已被锁定,请解除配置锁定之后在重试。 |
OperationDenied.DomainIsBlocked | 域名被封禁,暂时无法操作。 |
OperationDenied.DomainNoICP | 域名尚未备案。 |
OperationDenied.VersionControlLocked | 当前处于版本管理模式下,该操作不允许。 |
ResourceInUse.AliasName | 当前已存在相同的别称域名,不支持重复添加 |
ResourceInUse.DuplicateName | 已存在相同的别称域名。 |
ResourceInUse.Zone | 别称域名已站点接入。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable.DomainAlreadyExists | 当前域名已接入EdgeOne,如确认需要接入到当前账号,请进行域名找回。 |
UnauthorizedOperation | 未授权操作。 |
UnauthorizedOperation.CamUnauthorized | Cam 未授权。 |
UnsupportedOperation.TargetNameOriginTypeCos | 别称域名不支持目标域名源站类型为对象存储。 |