配置指南

API 文档

更新加速域名配置

最近更新时间:2022-04-21 06:08:13

我的收藏

1. 接口描述

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

UpdateDomainConfig 用于修改内容分发网络加速域名配置信息
注意:如果需要更新复杂类型的配置项,必须传递整个对象的所有属性,未传递的属性将使用默认值,建议通过查询接口获取配置属性后,直接修改后传递给本接口。Https配置由于证书的特殊性,更新时不用传递证书和密钥字段。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:UpdateDomainConfig。
Version String 公共参数,本接口取值:2018-06-06。
Region String 公共参数,本接口不需要传递此参数。
Domain String 域名
ProjectId Integer 项目 ID
Origin Origin 源站配置
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 浏览器缓存配置(功能灰度中,尚未全量)
SpecificConfig SpecificConfig 地域属性特殊配置
适用于域名境内加速、境外加速配置不一致场景
ServiceType String 域名业务类型
web:静态加速
download:下载加速
media:流媒体点播加速
Area String 域名加速区域
mainland:中国境内加速
overseas:中国境外加速
global:全球加速
从mainland/overseas修改至global时,域名的配置将被同步至overseas/mainland。若域名含有后端特殊配置,此类配置的同步过程有一定延时,请耐心等待
OriginPullTimeout OriginPullTimeout 回源超时配置
AwsPrivateAccess AwsPrivateAccess 回源S3私有鉴权
UserAgentFilter UserAgentFilter UA黑白名单配置
AccessControl AccessControl 访问控制
UrlRedirect UrlRedirect 访问URL重写配置
AccessPort.N Array of Integer 访问端口配置
AdvancedAuthentication AdvancedAuthentication 时间戳防盗链高级版配置,白名单功能
OriginAuthentication OriginAuthentication 回源鉴权高级版配置,白名单功能
Ipv6Access Ipv6Access Ipv6 访问配置
OfflineCache OfflineCache 离线缓存
OriginCombine OriginCombine 合并回源
PostMaxSize PostSize POST请求传输配置
Quic Quic Quic访问(收费服务,详见计费说明和产品文档)
OssPrivateAccess OssPrivateAccess 回源OSS私有鉴权
WebSocket WebSocket WebSocket配置
RemoteAuthentication RemoteAuthentication 远程鉴权配置
ShareCname ShareCname 共享CNAME配置,白名单功能
HwPrivateAccess HwPrivateAccess 华为云对象存储回源鉴权
QnPrivateAccess QnPrivateAccess 七牛云对象存储回源鉴权

3. 输出参数

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

4. 示例

示例1 更新域名配置

输入示例

https://cdn.tencentcloudapi.com/?Action=UpdateDomainConfig
&ProjectId=0
&Domain=www.test.com
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "23cd4005-496f-4bc4-87d8-ab348d5b0c17"
  }
}

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 系统错误,请联系腾讯云工程师进一步排查。
InternalError.Error 内部服务错误,请联系腾讯云工程师进一步排查。
InternalError.InvalidErrorCode 内部服务错误,请联系腾讯云工程师进一步排查。
InvalidParameter.AccessPortOpenedHttps 域名启用 HTTPS 配置需保持访问端口配置-443端口为开启状态。
InvalidParameter.BandLimitRequiredMainland 请删除域名的限流管理配置后再切换加速区域。
InvalidParameter.BandwidthAlertCounterMeasureConflictOriginType 源站类型为COS源或第三方对象存储的域名,用量封顶-超出阈值的处理方式仅支持访问返回404,请修改该配置后重试。
InvalidParameter.CDNStatusInvalidDomain 域名状态不合法。
InvalidParameter.CdnCertInfoNotFound 证书信息不存在或非法,请确认后重试。
InvalidParameter.CdnConfigInvalidCache 缓存配置不合法,请确认后重试。
InvalidParameter.CdnHostInvalidMiddleConfig 错误的中间源配置。
InvalidParameter.CdnHostInvalidStatus 域名状态不合法。
InvalidParameter.CdnInterfaceError 内部接口错误,请联系腾讯云工程师进一步排查。
InvalidParameter.CdnInvalidParamServiceType ServiceType字段不合法,请确认后重试。
InvalidParameter.CdnKeyRulesInvalidQueryStringValue QueryString字段不合法,请确认后重试。
InvalidParameter.CdnParamError 参数错误,请参考文档中示例参数填充。
InvalidParameter.CdnStatInvalidProjectId 项目ID错误,请确认后重试。
InvalidParameter.PathRegexTooManySubPattern 正则子模式超出上限。
InvalidParameter.RemoteAuthInvalidPlatform 域名所在平台不支持远程鉴权。
InvalidParameter.RemoteAuthInvalidProtocol 域名所在平台不支持使用https协议访问远程鉴权地址。
LimitExceeded.CdnConfigTooManyCacheRules 缓存配置规则数超出限制。
LimitExceeded.CdnHostOpTooOften 域名操作过于频繁。
ResourceInUse.CdnHostExists 域名已存在。
ResourceInUse.CdnOpInProgress CDN资源正在被操作中。
ResourceNotFound.CdnHostNotExists 账号下无此域名,请确认后重试。
ResourceNotFound.CdnUserNotExists 未开通CDN服务,请开通后使用此接口。
ResourceNotFound.EcdnDomainNotExists 域名不存在,请确认后重试。
ResourceUnavailable.CdnHostBelongsToOthersInMainland 该域名已在其他处接入中国境内服务地域,如需修改服务地域为全球,需验证取回域名。
ResourceUnavailable.CdnHostBelongsToOthersInOverseas 该域名已在其他处接入中国境外服务地域,如需修改服务地域为全球,需验证取回域名。
ResourceUnavailable.CdnHostIsLocked 域名被锁定。
ResourceUnavailable.CdnHostIsNotOffline 域名未下线。
ResourceUnavailable.CdnHostNoIcp 域名未备案。
UnauthorizedOperation.CdnCamUnauthorized 子账号未配置cam策略。
UnauthorizedOperation.CdnHostInIcpBlacklist 域名现存在风险,不可接入。
UnauthorizedOperation.CdnHostUnauthorized CDN子账号加速域名未授权。
UnauthorizedOperation.CdnProjectUnauthorized 子账号项目未授权。
UnauthorizedOperation.CdnTagUnauthorized 子账号标签未授权。
UnauthorizedOperation.CdnUserAuthFail CDN用户认证失败。
UnauthorizedOperation.CdnUserAuthWait CDN用户待认证。
UnauthorizedOperation.CdnUserIsIsolated 账号由于欠费被隔离,请冲正后重试。
UnauthorizedOperation.CdnUserIsSuspended 加速服务已停服,请重启加速服务后重试。
UnauthorizedOperation.CdnUserNoWhitelist 非内测白名单用户,无该功能使用权限。
UnauthorizedOperation.OpNoAuth 暂不支持此操作,请联系腾讯云工程师处理。
UnauthorizedOperation.OperationTooOften 操作超出调用频次限制。
目录