1. 接口描述
此接口处于预下线状态 。
预计下线时间:2023-07-25 18:59:40
接口请求域名: ecdn.tencentcloudapi.com 。
ECDN融合CDN后,接口都用CDN的,此接口已经废弃
本接口(UpdateDomainConfig)用于更新ECDN加速域名配置信息。
注意:如果需要更新复杂类型的配置项,必须传递整个对象的所有属性,未传递的属性将使用默认值。建议通过查询接口获取配置属性后,直接修改后传递给本接口。Https配置由于证书的特殊性,更新时不用传递证书和密钥字段。
说明:若您的业务已迁移至 CDN 控制台,请参考 CDN 接口文档,使用 CDN 相关API 进行操作。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:UpdateDomainConfig。 |
Version | 是 | String | 公共参数,本接口取值:2019-10-12。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Domain | 是 | String | 域名。 示例值:www.test.com |
Origin | 否 | Origin | 源站配置。 |
ProjectId | 否 | Integer | 项目id。 示例值:0 |
IpFilter | 否 | IpFilter | IP黑白名单配置。 |
IpFreqLimit | 否 | IpFreqLimit | IP限频配置。 |
ResponseHeader | 否 | ResponseHeader | 源站响应头部配置。 |
CacheKey | 否 | CacheKey | 节点缓存配置。 |
Cache | 否 | Cache | 缓存规则配置。 |
Https | 否 | Https | Https配置。 |
ForceRedirect | 否 | ForceRedirect | 访问协议强制跳转配置。 |
Area | 否 | String | 域名加速区域,mainland,overseas或global,分别表示中国境内加速,海外加速或全球加速。 示例值:mainland |
WebSocket | 否 | WebSocket | WebSocket配置 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 更新域名配置
输入示例
https://ecdn.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。
- 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.EcdnConfigError | 域名配置更新操作失败,请重试或联系客服人员解决。 |
InternalError.EcdnConfigError | 内部配置服务错误,请重试或联系客服人员解决。 |
InternalError.EcdnDbError | 内部数据错误,请联系腾讯云工程师进一步排查。 |
InternalError.EcdnSystemError | 系统错误,请联系腾讯云工程师进一步排查。 |
InvalidParameter.EcdnInterfaceError | 内部接口错误,请联系腾讯云工程师进一步排查。 |
InvalidParameter.EcdnInvalidParamArea | 非法Area参数,请参考文档中示例参数填充。 |
InvalidParameter.EcdnParamError | 参数错误,请参考文档中示例参数填充。 |
LimitExceeded.EcdnDomainOpTooOften | 域名操作过于频繁。 |
ResourceInUse.EcdnOpInProgress | ECDN资源正在被操作中。 |
ResourceNotFound.EcdnDomainNotExists | 账号下无此域名,请确认后重试。 |
ResourceNotFound.EcdnProjectNotExists | 项目不存在。 |
ResourceNotFound.EcdnUserNotExists | 未开通ECDN服务,请开通后使用此接口。 |
ResourceUnavailable.EcdnDomainIsLocked | 域名已锁定,请联系腾讯云工程师 。 |
UnauthorizedOperation.EcdnCamUnauthorized | 子账号未配置cam策略。 |
UnauthorizedOperation.EcdnDomainUnauthorized | ECDN子账号加速域名未授权。 |
UnauthorizedOperation.EcdnMigratedCdn | 请前往CDN控制台进行操作 。 |
UnauthorizedOperation.EcdnProjectUnauthorized | 子账号项目未授权。 |
UnauthorizedOperation.EcdnUserIsSuspended | 加速服务已停服,请重启加速服务后重试。 |
UnauthorizedOperation.EcdnUserNoWhitelist | 非内测白名单用户,无该功能使用权限。 |