1. 接口描述
接口请求域名: teo.tencentcloudapi.com 。
在创建完站点之后,您可以通过本接口创建加速域名。
CNAME 模式接入时,若您未完成站点归属权校验,本接口将为您返回域名归属权验证信息,您可以单独对域名进行归属权验证,详情参考 站点/域名归属权验证。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateAccelerationDomain。 |
Version | 是 | String | 公共参数,本接口取值:2022-09-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
ZoneId | 是 | String | 加速域名所属站点 ID。 |
DomainName | 是 | String | 加速域名。 |
OriginInfo | 是 | OriginInfo | 源站信息。 |
OriginProtocol | 否 | String | 回源协议,取值有: |
HttpOriginPort | 否 | Integer | HTTP回源端口,取值为1-65535,当OriginProtocol=FOLLOW/HTTP时生效, 不填默认为80。 |
HttpsOriginPort | 否 | Integer | HTTPS回源端口,取值为1-65535,当OriginProtocol=FOLLOW/HTTPS时生效,不填默认为443。 |
IPv6Status | 否 | String | IPv6状态,取值有: |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
OwnershipVerification | OwnershipVerification | 当您的站点未进行归属权验证时,您可通过该参数返回的信息单独对域名进行归属权校验。详情参考 站点/域名归属权验证。 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建源站类型为域名的加速域名
创建源站类型为域名的加速域名。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAccelerationDomain
<公共请求参数>
{
"ZoneId": "zone-225qgrnvbi9w",
"DomainName": "qq.com",
"OriginInfo": {
"OriginType": "ip_domain",
"Origin": "www.test.com"
}
}
输出示例
{
"Response": {
"RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707"
}
}
示例2 创建源站类型为 AWS S3 的加速域名
创建源站类型为 AWS S3,开启私有访问,鉴权算法版本为 AWS signature v2 的加速域名。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAccelerationDomain
<公共请求参数>
{
"ZoneId": "zone-225qgrnvbi9w",
"DomainName": "qq.com",
"OriginInfo": {
"OriginType": "AWS_S3",
"Origin": "test.s3.ap-east-1.amazonaws.com",
"PrivateAccess": "on",
"PrivateParameters": [
{
"Name": "AccessKeyId",
"Value": "AKIDdDva7VjFk7LQJ0X5WnbKE7mQTest"
},
{
"Name": "SecretAccessKey",
"Value": "nMirpdWhhT6bxPsaFwYM1SzQrTest"
},
{
"Name": "SignatureVersion",
"Value": "v2"
},
{
"Name": "Region",
"Value": "ap-east-1"
}
]
}
}
输出示例
{
"Response": {
"RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a703"
}
}
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 | 操作失败。 |
InternalError.ConfigLocked | 配置已被锁定,请解除配置锁定之后在重试。 |
InvalidParameter.ConflictHostOrigin | 源站不能和域名一致。 |
InvalidParameter.ErrInvalidActionParam | 非法操作-非法参数。 |
InvalidParameter.InvalidAccelerateType | 参数错误。 |
InvalidParameter.InvalidAwsPrivateAccess | 无效的第三方对象存储。 |
InvalidParameter.InvalidAwsRegion | 请正确填写地域作为第三方对象存储私有访问参数。 |
InvalidParameter.InvalidClientIpOrigin | 分区域回源的源站无效。 |
InvalidParameter.InvalidIpv6Switch | 无效的Ipv6开关配置。 |
InvalidParameter.InvalidOrigin | 无效的源站。 |
InvalidParameter.InvalidOriginIp | 不支持填写内网IP/回环地址作为源站地址 |
InvalidParameter.InvalidPrivateAccessParams | 请填写AccessKeyId、SecretAccessKey作为第三方对象存储私有访问参数。 |
InvalidParameter.InvalidPrivateAccessSwitch | 请指定PrivateAccess参数值为on/off。 |
InvalidParameter.InvalidQuicBilling | 套餐包不支持Quic配置。 |
InvalidParameter.InvalidServerName | 无效的回源Host。 |
InvalidParameter.InvalidStandardDebugClientIp | 无效的客户端ip或ip段。 |
InvalidParameter.InvalidWebSocketTimeout | 无效的WebSocket。 |
InvalidParameter.PostMaxSizeLimitExceeded | 最大上传大小超出限制 |
InvalidParameter.SpaceNotBindOrigin | Shield Space 未绑定源站,请先绑定源站后重试。 |
InvalidParameter.ZoneIsGrayPublishing | 站点升级中,暂不支持进行变更操作,请稍后再试。 |
InvalidParameterValue.ConflictRecord | 与已经添加的记录冲突。 |
InvalidParameterValue.ConflictWithDNSSEC | DNS 记录与 DNSSEC 功能冲突。 |
InvalidParameterValue.ConflictWithNSRecord | DNS 记录与 NS 记录冲突。 |
InvalidParameterValue.ContentSameAsName | 主机记录与记录值不能取值相同。 |
InvalidParameterValue.DomainNotMatchZone | 入参中的域名与站点参数不匹配,请更正后重试。 |
InvalidParameterValue.InvalidDNSContent | DNS 记录内容错误。 |
InvalidParameterValue.InvalidDNSName | DNS 记录名称错误。 |
InvalidParameterValue.InvalidDomainName | 加速域名名称不合法,加速域名应该由数字、英文字母、连词符组成,且连词符不能位于开头和结尾处。 |
InvalidParameterValue.InvalidProxyOrigin | DNS 代理域名源站错误。 |
InvalidParameterValue.OriginGroupNotExists | 指定的源站组不存在。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.AccelerateMainlandDisable | 功能内测中,请联系商务开启「中国大陆网络优化(国际加速)」功能。 |
OperationDenied.ConfigLocked | 配置已被锁定,请解除配置锁定之后在重试。 |
OperationDenied.DisableZoneNotCompleted | 站点停用未完毕,请稍后再试。 |
OperationDenied.DomainNoICP | 域名尚未备案。 |
OperationDenied.ErrZoneIsAlreadyPaused | 站点处于停用状态,请开启后重试。 |
OperationDenied.InvalidAdvancedDefenseZoneArea | 开启高防必须保证站点加速区域是国内。 |
OperationDenied.LoadBalanceStatusNotInOnline | 绑定负载均衡有处于非运行中的状态,禁止操作。 |
OperationDenied.RecordIsForbidden | DNS 记录不允许添加。 |
OperationDenied.ResourceLockedTemporary | 当前有互相排斥的请求操作并行发起,请稍后重试。 |
OperationDenied.VersionControlIsGraying | 存在使用中的测试版本,请将测试版本发布现网或者回滚测试版本再重试。 |
ResourceInUse | 资源被占用。 |
ResourceInUse.DnsRecord | 该域名正在解析中,如果您需要开启加速,请前往 DNS 记录页开启加速。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable.DomainAlreadyExists | 当前域名已接入EdgeOne,如确认需要接入到当前账号,请进行域名找回。 |
ResourcesSoldOut.L7LackOfResources | 资源售卖火爆,已售罄,正在加紧补货中,当前无法新增域名,请您耐心等待。 |
UnauthorizedOperation.CamUnauthorized | Cam 未授权。 |
UnauthorizedOperation.NoPermission | 子账户没有操作权限,请添加权限后继续操作。 |
UnauthorizedOperation.Unknown | 后端服务器发生未知错误。 |