1. 接口描述
接口请求域名: cdn.tencentcloudapi.com 。
AddCdnDomain 用于新增内容分发网络加速域名。1分钟内最多可新增100个域名。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:AddCdnDomain。 |
Version | 是 | String | 公共参数,本接口取值:2018-06-06。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Domain | 是 | String | 域名 示例值:www.test.com |
ServiceType | 是 | String | 加速域名业务类型 web:网页小文件 download:下载大文件 media:音视频点播 hybrid: 动静加速 dynamic: 动态加速 示例值:web |
Origin | 是 | Origin | 源站配置 |
ProjectId | 否 | Integer | 项目 ID,默认为 0,代表【默认项目】 示例值:0 |
IpFilter | 否 | IpFilter | IP 黑白名单配置 |
IpFreqLimit | 否 | IpFreqLimit | IP 限频配置 |
StatusCodeCache | 否 | StatusCodeCache | 状态码缓存配置 |
Compression | 否 | Compression | 智能压缩配置 |
BandwidthAlert | 否 | BandwidthAlert | 带宽封顶配置 |
RangeOriginPull | 否 | RangeOriginPull | Range 回源配置 |
FollowRedirect | 否 | FollowRedirect | 301/302 回源跟随配置。 |
ErrorPage | 否 | ErrorPage | 错误码重定向配置(功能灰度中,尚未全量) |
RequestHeader | 否 | RequestHeader | 请求头部配置 |
ResponseHeader | 否 | ResponseHeader | 响应头部配置 |
DownstreamCapping | 否 | DownstreamCapping | 下载速度配置 |
CacheKey | 否 | CacheKey | 节点缓存键配置 |
ResponseHeaderCache | 否 | ResponseHeaderCache | 头部缓存配置 |
VideoSeek | 否 | VideoSeek | 视频拖拽配置 |
Cache | 否 | Cache | 缓存过期时间配置 |
OriginPullOptimization | 否 | OriginPullOptimization | 跨国链路优化配置 |
Https | 否 | Https | Https 加速配置 |
Authentication | 否 | Authentication | 时间戳防盗链配置 |
Seo | 否 | Seo | SEO 优化配置 |
ForceRedirect | 否 | ForceRedirect | 访问协议强制跳转配置 |
Referer | 否 | Referer | Referer 防盗链配置 |
MaxAge | 否 | MaxAge | 浏览器缓存配置(功能灰度中,尚未全量) |
Ipv6 | 否 | Ipv6 | Ipv6 配置(功能灰度中,尚未全量) |
SpecificConfig | 否 | SpecificConfig | 地域属性特殊配置 适用于域名境内加速、境外加速配置不一致场景 |
Area | 否 | String | 域名加速区域 mainland:中国境内加速 overseas:中国境外加速 global:全球加速 使用中国境外加速、全球加速时,需要先开通中国境外加速服务 示例值:mainland |
OriginPullTimeout | 否 | OriginPullTimeout | 回源超时配置 |
Tag.N | 否 | Array of Tag | 标签配置 |
Ipv6Access | 否 | Ipv6Access | Ipv6 访问配置 |
OfflineCache | 否 | OfflineCache | 离线缓存 |
Quic | 否 | Quic | Quic访问(收费服务,详见计费说明和产品文档) |
AwsPrivateAccess | 否 | AwsPrivateAccess | 回源S3私有鉴权 |
OssPrivateAccess | 否 | OssPrivateAccess | 回源OSS私有鉴权 |
HwPrivateAccess | 否 | HwPrivateAccess | 华为云对象存储回源鉴权 |
QnPrivateAccess | 否 | QnPrivateAccess | 七牛云对象存储回源鉴权 |
OthersPrivateAccess | 否 | OthersPrivateAccess | 其他厂商对象存储回源鉴权 |
HttpsBilling | 否 | HttpsBilling | HTTPS服务,默认开启(收费服务,详见计费说明和产品文档) |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 新增加速域名
新增加速域名
输入示例
POST / HTTP/1.1
Host: cdn.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddCdnDomain
<公共请求参数>
{
"Origin": {
"OriginType": "ip",
"Origins": [
"1.1.1.1"
]
},
"ProjectId": "0",
"Domain": "www.test.com",
"ServiceType": "web",
"Area": "mainland"
}
输出示例
{
"Response": {
"RequestId": "a4ac88a3-a159-47ac-9b87-19185d7deb09"
}
}
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.CdnConfigError | 域名配置更新操作失败,请重试或联系客服人员解决。 |
InternalError.CdnConfigError | 域名配置更新失败。 |
InternalError.CdnDbError | 内部数据错误,请联系腾讯云工程师进一步排查。 |
InternalError.CdnSystemError | 系统错误,请联系腾讯云工程师进一步排查。 |
InternalError.ProxyServer | 内部服务错误,请联系腾讯云工程师进一步排查。 |
InvalidParameter.CamResourceBelongToDifferentUser | 同一次请求的资源AppId不一致。 |
InvalidParameter.CamResourceSixStageError | 资源六段式标记参数错误。 |
InvalidParameter.CamTagKeyAlreadyAttached | 域名已与该标签关联,请勿重复操作。 |
InvalidParameter.CamTagKeyIllegal | 标签键字符不合法。 |
InvalidParameter.CamTagKeyNotExist | 标签键不存在。 |
InvalidParameter.CamTagValueIllegal | 标签值字符不合法。 |
InvalidParameter.CdnCertInfoNotFound | 证书信息不存在或非法,请确认后重试。 |
InvalidParameter.CdnConfigInvalidHost | 域名不符合规范,请确认域名是否符合规范。 |
InvalidParameter.CdnConfigInvalidTag | 标签配置不合法。 |
InvalidParameter.CdnConfigTagRequired | 域名添加失败,当前域名必须选择标签,请确认后重试。 |
InvalidParameter.CdnHostInternalHost | 该域名属于指定账号域名,不允许接入。 |
InvalidParameter.CdnHostIsCosDefaultAccess | 该域名为COS访问域名,无法接入,如需启动加速服务,请前往COS控制台启用默认 CDN 加速域。 |
InvalidParameter.CdnHostTooLongHost | 域名太长。 |
InvalidParameter.CdnInterfaceError | 内部接口错误,请联系腾讯云工程师进一步排查。 |
InvalidParameter.CdnKeyRulesInvalidQueryStringValue | QueryString字段不合法,请确认后重试。 |
InvalidParameter.CdnParamError | 参数错误,请参考文档中示例参数填充。 |
InvalidParameter.CdnStatTooManyDomains | 查询的域名数量超过限制。 |
LimitExceeded.CamResourceArrayTooLong | 资源数组超过最大值。 |
LimitExceeded.CamResourceTooManyTagKey | 单个资源标签键数不能超过50。 |
LimitExceeded.CamTagKeyTooLong | 标签键长度超过最大值。 |
LimitExceeded.CamTagKeyTooManyTagValue | 单个标签键对应标签值不能超过1000。 |
LimitExceeded.CamTagQuotaExceedLimit | 域名绑定标签数量超出限制。 |
LimitExceeded.CamUserTooManyTagKey | 单个用户最多1000个不同的key。 |
LimitExceeded.CdnConfigTooManyCacheRules | 缓存配置规则数超出限制。 |
LimitExceeded.CdnHostOpTooOften | 域名操作过于频繁。 |
LimitExceeded.CdnUserTooManyHosts | 用户域名数量已达上限,请联系腾讯云工程师处理。 |
ResourceInUse.CdnConflictHostExists | 域名与系统中已存在域名存在冲突。 |
ResourceInUse.CdnHostExists | 域名已存在。 |
ResourceInUse.CdnOpInProgress | CDN资源正在被操作中。 |
ResourceNotFound.CamTagKeyNotExist | 标签键不存在。 |
ResourceNotFound.CdnHostNotExists | 未查询到该域名,请确认域名是否正确。 |
ResourceNotFound.CdnUserNotExists | 未开通CDN服务,请开通后使用此接口。 |
ResourceUnavailable.CdnHostExistsInDsa | 域名已接入DSA功能。 |
ResourceUnavailable.CdnHostExistsInTcb | 域名已经在TCB控制台接入。 |
ResourceUnavailable.CdnHostIsMalicious | 该域名有违法违规风险,不可接入。 |
ResourceUnavailable.CdnHostNoIcp | 域名未备案,请将域名备案。备案同步周期为2小时,若域名已备案,可稍后重新接入。 |
ResourceUnavailable.HostExistInVod | 该域名已在云点播内接入,请先在云点播内删除域名后再接入。 |
UnauthorizedOperation.CdnCamUnauthorized | 子账号未配置cam策略。 |
UnauthorizedOperation.CdnDomainRecordNotVerified | 域名解析未进行验证。 |
UnauthorizedOperation.CdnHostExistsInInternal | 域名在内部系统已存在,请提工单处理。 |
UnauthorizedOperation.CdnHostInIcpBlacklist | 该域名涉及违法违规风险,不可接入。 |
UnauthorizedOperation.CdnHostIsOwnedByOther | 该域名属于其他账号,您没有权限接入。 |
UnauthorizedOperation.CdnHostIsUsedByOther | 域名已被其他账号接入,更多详情请提交工单联系我们。 |
UnauthorizedOperation.CdnHostUnauthorized | CDN子账号加速域名未授权。 |
UnauthorizedOperation.CdnTagUnauthorized | 子账号标签未授权。 |
UnauthorizedOperation.CdnUserAuthFail | CDN用户认证失败。 |
UnauthorizedOperation.CdnUserAuthWait | CDN用户待认证。 |
UnauthorizedOperation.CdnUserIsIsolated | 账号由于欠费被隔离,请冲正后重试。 |
UnauthorizedOperation.CdnUserIsSuspended | 加速服务已停服,请重启加速服务后重试。 |
UnauthorizedOperation.CdnUserNoWhitelist | 非内测白名单用户,无该功能使用权限。 |
UnauthorizedOperation.OpNoAuth | 暂不支持此操作,请联系腾讯云工程师处理。 |
UnauthorizedOperation.OperationTooOften | 操作超出调用频次限制。 |
UnsupportedOperation.OpNoAuth | 暂不支持此操作,请联系腾讯云工程师处理。 |