API 文档

新增加速域名

最近更新时间:2021-01-07 08:03:23

我的收藏

1. 接口描述

接口请求域名: cdn.tencentcloudapi.com 。

AddCdnDomain 用于新增内容分发网络加速域名。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:AddCdnDomain。
Version String 公共参数,本接口取值:2018-06-06。
Region String 公共参数,本接口不需要传递此参数。
Domain String 域名
ServiceType String 加速域名业务类型
web:静态加速
download:下载加速
media:流媒体点播加速
Origin Origin 源站配置
ProjectId Integer 项目 ID,默认为 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:全球加速
使用中国境外加速、全球加速时,需要先开通中国境外加速服务
OriginPullTimeout OriginPullTimeout 回源超时配置
Tag.N Array of Tag 标签配置
Ipv6Access Ipv6Access Ipv6 访问配置
OfflineCache OfflineCache 离线缓存

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 新增加速域名

输入示例

https://cdn.tencentcloudapi.com/?Action=AddCdnDomain
&Domain=www.test.com
&ServiceType=web
&ProjectId=0
&Area=mainland
&Origin.Origins.0=1.1.1.1
&Origin.OriginType=ip
&<公共请求参数>

输出示例

{
  "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。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.CdnConfigError 域名配置更新操作失败,请重试或联系客服人员解决。
InternalError.CdnConfigError 域名配置更新失败。
InternalError.CdnDbError 内部数据错误,请联系腾讯云工程师进一步排查。
InternalError.CdnSystemError 系统错误,请联系腾讯云工程师进一步排查。
InvalidParameter.CamResourceBelongToDifferentUser 同一次请求的资源AppId不一致。
InvalidParameter.CamResourceSixStageError 资源六段式标记参数错误。
InvalidParameter.CamTagKeyAlreadyAttached 域名已与该标签关联,请勿重复操作。
InvalidParameter.CamTagKeyIllegal 标签键字符不合法。
InvalidParameter.CamTagKeyNotExist 标签键不存在。
InvalidParameter.CamTagValueIllegal 标签值字符不合法。
InvalidParameter.CdnConfigInvalidHost 域名不合法。
InvalidParameter.CdnConfigInvalidTag 标签配置不合法。
InvalidParameter.CdnConfigTagRequired 域名添加失败,当前域名必须选择标签,请确认后重试。
InvalidParameter.CdnHostInternalHost 内部域名不允许接入。
InvalidParameter.CdnInterfaceError 内部接口错误,请联系腾讯云工程师进一步排查。
InvalidParameter.CdnParamError 参数错误,请参考文档中示例参数填充。
LimitExceeded.CamResourceArrayTooLong 资源数组超过最大值。
LimitExceeded.CamResourceTooManyTagKey 单个资源标签键数不能超过50。
LimitExceeded.CamTagKeyTooLong 标签键长度超过最大值。
LimitExceeded.CamTagKeyTooManyTagValue 单个标签键对应标签值不能超过1000。
LimitExceeded.CamUserTooManyTagKey 单个用户最多1000个不同的key。
LimitExceeded.CdnHostOpTooOften 域名操作过于频繁。
LimitExceeded.CdnUserTooManyHosts 接入域名数超出限制。
ResourceInUse.CdnConflictHostExists 域名与系统中已存在域名存在冲突。
ResourceInUse.CdnHostExists 域名已存在。
ResourceInUse.CdnOpInProgress CDN资源正在被操作中。
ResourceNotFound.CamTagKeyNotExist 标签键不存在。
ResourceNotFound.CamTagNotExist 标签不存在。
ResourceNotFound.CdnUserNotExists 未开通CDN服务,请开通后使用此接口。
ResourceUnavailable.CdnHostExistsInTcb 域名已经在TCB控制台接入。
ResourceUnavailable.CdnHostNoIcp 域名未备案。
UnauthorizedOperation.CdnCamUnauthorized 子账号未配置cam策略。
UnauthorizedOperation.CdnDomainRecordNotVerified 域名解析未进行验证。
UnauthorizedOperation.CdnHostExistsInInternal 域名在内部系统已存在,请提工单处理。
UnauthorizedOperation.CdnHostIsOwnedByOther 该域名属于其他账号,您没有权限接入。
UnauthorizedOperation.CdnHostIsUsedByOther 域名已被其他账号接入,更多详情请提交工单联系我们。
UnauthorizedOperation.CdnHostUnauthorized CDN子账号加速域名未授权。
UnauthorizedOperation.CdnTagUnauthorized 子账号标签未授权。
UnauthorizedOperation.CdnUserAuthFail CDN用户认证失败。
UnauthorizedOperation.CdnUserAuthWait CDN用户待认证。
UnauthorizedOperation.CdnUserIsSuspended 加速服务已停服,请重启加速服务后重试。
UnauthorizedOperation.CdnUserNoWhitelist 非内测白名单用户,无该功能使用权限。
UnauthorizedOperation.OpNoAuth 暂不支持此操作,请联系腾讯云工程师处理。
UnsupportedOperation.OpNoAuth 暂不支持此操作,请联系腾讯云工程师处理。
目录