1. 接口描述
接口请求域名: cdn.tencentcloudapi.com 。
ModifyDomainConfig 用于修改内容分发网络加速域名配置信息
注意:
Route 字段,使用点分隔,最后一段称为叶子节点,非叶子节点配置保持不变;
Value 字段,使用 json 进行序列化,其中固定 update 作为 key,配置路径值参考 https://cloud.tencent.com/document/product/228/41116 接口各配置项复杂类型,为配置路径对应复杂类型下的节点。
操作审计相关:接口的入参可能包含密钥等敏感信息,所以此接口的入参不会上报到操作审计。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyDomainConfig。 |
Version | 是 | String | 公共参数,本接口取值:2018-06-06。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Domain | 是 | String | 域名 示例值:www.test.com |
Route | 是 | String | 配置路径 示例值:Https.CertInfo.CertId |
Value | 是 | String | 配置路径值,使用 json 进行序列化,其中固定 update 作为 key 示例值:{"update":"0VpOXiPz"} |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 更新域名源站配置
更新域名源站配置
输入示例
POST / HTTP/1.1
Host: cdn.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDomainConfig
<公共请求参数>
{
"Domain": "www.test.com",
"Route": "Origin.Origins",
"Value": "{\"update\":[\"1.1.1.1\"]}"
}
输出示例
{
"Response": {
"RequestId": "eb029ee0-7e91-4a18-86f3-7fac952a446e"
}
}
示例2 更新域名回源超时配置
更新域名回源超时配置
输入示例
POST / HTTP/1.1
Host: cdn.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDomainConfig
<公共请求参数>
{
"Domain": "www.test.com",
"Route": "OriginPullTimeout",
"Value": "{\"update\":{\"ConnectTimeout\":10,\"ReceiveTimeout\":10}}"
}
输出示例
{
"Response": {
"RequestId": "23cd4005-496f-4bc4-87d8-ab348d5b0c21"
}
}
示例3 更新域名回源建连超时时间
更新域名回源建连超时时间
输入示例
POST / HTTP/1.1
Host: cdn.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDomainConfig
<公共请求参数>
{
"Domain": "www.test.com",
"Route": "OriginPullTimeout.ConnectTimeout",
"Value": "{\"update\":10}"
}
输出示例
{
"Response": {
"RequestId": "23cd4005-496f-4bc4-87d8-ab348d5b0c11"
}
}
示例4 更新 HTTPS 服务器证书 ID(在 SSL 证书管理进行证书托管时自动生成)
更新 HTTPS 服务器证书 ID(在 SSL 证书管理进行证书托管时自动生成)
输入示例
POST / HTTP/1.1
Host: cdn.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDomainConfig
<公共请求参数>
{
"Domain": "www.test.com",
"Route": "Https.CertInfo.CertId",
"Value": "{\"update\":\"0VpOXiPz\"}"
}
输出示例
{
"Response": {
"RequestId": "56a166ec-d784-4001-a850-7d62a5c07971"
}
}
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.CamSystemError | 内部鉴权系统错误。 |
InternalError.CdnConfigError | 域名配置更新失败。 |
InternalError.CdnDbError | 内部数据错误,请联系腾讯云工程师进一步排查。 |
InternalError.CdnQuerySystemError | 内部查询错误,请重试或联系客服人员解决。 |
InternalError.CdnSystemError | 系统错误,请联系腾讯云工程师进一步排查。 |
InternalError.Error | 内部服务错误,请联系腾讯云工程师进一步排查。 |
InternalError.InvalidErrorCode | 内部服务错误,请联系腾讯云工程师进一步排查。 |
InternalError.ProxyServer | 内部服务错误,请联系腾讯云工程师进一步排查。 |
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.CdnKeyRulesExcludeCustomRequiresFullLego | 配置暂不支持开启该配置。 |
InvalidParameter.CdnKeyRulesInvalidQueryStringValue | QueryString字段不合法,请确认后重试。 |
InvalidParameter.CdnParamError | 参数错误,请参考文档中示例参数填充。 |
InvalidParameter.CdnStatInvalidProjectId | 项目ID错误,请确认后重试。 |
InvalidParameter.CdnStatTooManyDomains | 查询的域名数量超过限制。 |
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 | 域名未备案,请将域名备案。备案同步周期为2小时,若域名已备案,可稍后重新接入。 |
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 | 操作超出调用频次限制。 |