1. 接口描述
接口请求域名: teo.tencentcloudapi.com 。
本接口用于配置回源限速限制,该功能白名单内测中。
可通过此接口创建、修改与删除预热回源限速限制,每个账号最多支持 100 条限制。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ModifyPrefetchOriginLimit。 |
| Version | 是 | String | 公共参数,本接口取值:2022-09-01。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| ZoneId | 是 | String | 站点 ID。 |
| DomainName | 是 | String | 加速域名。 |
| Area | 是 | String | 回源限速限制的加速区域。 预热时,该加速区域将会受到配置的Bandwidth值限制。取值有: |
| Bandwidth | 是 | Integer | 回源限速带宽。 预热时回到源站的带宽上限值,取值范围 100 - 100,000,单位 Mbps。 |
| Enabled | 是 | String | 回源限速限制控制开关。 用于启用/删除本条回源限速限制,取值有: |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建回源限速带宽限制
创建 cn2.test-***a.online 的预热回源限制,配置预热的全球可用区(不含中国大陆)加速区域上回源带宽为100Mbps。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyPrefetchOriginLimit
<公共请求参数>
{
"ZoneId": "zone-3***j8tqd",
"DomainName": "cn2.test-***a.online",
"Area": "Overseas",
"Bandwidth": 100,
"Enabled": "on"
}
输出示例
{
"Response": {
"RequestId": "591c01a2-af21-4c09-af23-8f7d96832d01"
}
}
示例2 删除回源限速带宽限制
删除 cn2.test-***a.online 的限制。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyPrefetchOriginLimit
<公共请求参数>
{
"ZoneId": "zone-3***j8tqd",
"DomainName": "cn2.test-***a.online",
"Area": "Overseas",
"Bandwidth": 100,
"Enabled": "off"
}
输出示例
{
"Response": {
"RequestId": "67a3d9f3-b852-4f6e-af7d-cc66ebc4fb08"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.CreatePrefetchOriginLimitFailed | 创建预热回源限速配置失败,请稍后重试或提交工单。 |
| FailedOperation.PrefetchOriginLimitCountExceeded | 超出配置数量限制,无法创建更多,请删除不必要配置或申请提升配置数量。 |
| FailedOperation.PrefetchOriginLimitNotFound | 未找到对应预热回源限速配置,请确认是否存在配置后重试。 |
| InternalError.BackendError | 后台处理出错。 |
| InternalError.DomainConfig | 获取配置失败。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.DomainAreaNotSupportPrefetchOriginLimitArea | 域名加速区域,无法支持该预热回源限速区域配置,请调整后重新提交。 |
| InvalidParameter.DomainNotFound | 域名不存在或不属于该账号。 |
| InvalidParameter.PrefetchOriginLimitAreaInvalid | 预热回源限速区域参数无效,请调整区域后重新提交。 |
| InvalidParameter.PrefetchOriginLimitBandwidthTooLarge | 预热回源限速带宽值过大,请调整后重新提交。 |
| InvalidParameter.PrefetchOriginLimitBandwidthTooSmall | 预热回源限速带宽值过小,请调整后重新提交。 |
| InvalidParameter.PrefetchOriginLimitEnabledInvalid | 预热回源限速控制开关参数无效,请调整区域后重新提交。 |
| InvalidParameter.ZoneAreaNotSupportPrefetchOriginLimitArea | 站点加速区域,无法支持该预热回源限速区域配置,请调整后重新提交。 |
| OperationDenied.NotInPrefetchOriginLimitWhiteList | 不在预热回源限速配置白名单中,请提交工单。 |
| ResourceInUse.PrefetchOriginLimitAlreadyExists | 预热回源限速配置已存在,无法重复创建,请检查是否已创建对应配置。 |
| UnauthorizedOperation.CamUnauthorized | Cam 未授权。 |
| UnauthorizedOperation.NoPermission | 子账户没有操作权限,请添加权限后继续操作。 |
| UnauthorizedOperation.Unknown | 后端服务器发生未知错误。 |