1. 接口描述
接口请求域名: teo.tencentcloudapi.com 。
本接口用于站点首次开启源站防护,启用后 EdgeOne 将会使用特定的回源 IP 网段为七层加速域名/四层代理实例回源。单次支持提交的七层加速域名的数量最大为 200,四层代理实例的数量最大为 100,支持七层加速域名/四层代理实例混合提交,总实例个数最大为 200。如需要启用超过 200 个资源,可先通过指定资源的方式以最大数量启用,剩余资源通过 ModifyOriginACL 接口启用。后续新增七层加速域名/四层代理实例均请通过 ModifyOriginACL 接口配置。
注意:
- 调用本接口视为同意 源站防护启用特别约定;
- 回源 IP 网段会不定期变更,EdgeOne 将在回源 IP 网段变更前 14 天、前 7 天、前 3 天和前 1 天分别通过站内信、短信、邮件等一种或多种方式发起通知,为了能正常收到回源 IP 网段的变更通知,请务必确保您在 腾讯云消息中心控制台内,已勾选边缘安全加速平台 EO 的产品服务相关消息通知,并配置正确的消息接收人。配置方式请参考 消息订阅管理。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:EnableOriginACL。 |
Version | 是 | String | 公共参数,本接口取值:2022-09-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
ZoneId | 是 | String | 站点 ID。 |
L7EnableMode | 否 | String | 七层加速域名开启源站防护的模式。 |
L7Hosts.N | 否 | Array of String | 开启源站防护的七层加速域名列表,仅当参数 L7EnableMode 为 specific 时生效。L7EnableMode 为 all 时,请保留此参数为空。单次最大仅支持填写 200 个七层加速域名。 |
L4EnableMode | 否 | String | 四层代理实例开启源站防护的模式。 |
L4ProxyIds.N | 否 | Array of String | 开启源站防护的四层代理实例列表,仅当参数 L4EnableMode 为 specific 时生效。L4EnableMode 为 all 时,请保留此参数为空。单次最大仅支持填写 100 个四层代理实例。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 站点首次启用源站防护,并配置为指定七层加速域名/四层代理实例启用特定回源 IP 网段回源
ZoneId 为 'zone-276zs184g93m' 的站点开启源站防护,并配置七层加速域名‘www.qq.com’和四层代理实例‘sid-19389e5dwwxfs’启用特定回源 IP 网段回源。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: EnableOriginACL
<公共请求参数>
{
"ZoneId": "zone-276zs184g93m",
"L7EnableMode": "specific",
"L7Hosts": [
"www.qq.com"
],
"L4EnableMode": "specific",
"L4ProxyIds": [
"sid-19389e5dwwxfs"
]
}
输出示例
{
"Response": {
"RequestId": "9e0a2b4f-df6d-4d2a-ac39-1706cbf8a869"
}
}
示例2 站点首次启用源站防护,并配置为指定七层加速域名启用特定回源 IP 网段回源
ZoneId 为 'zone-276zs184g93m' 的站点开启源站防护,并配置七层加速域名‘www.qq.com’启用特定回源 IP 网段回源。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: EnableOriginACL
<公共请求参数>
{
"ZoneId": "zone-276zs184g93m",
"L7EnableMode": "specific",
"L7Hosts": [
"www.qq.com"
]
}
输出示例
{
"Response": {
"RequestId": "9e0a2b4f-df6d-4d2a-ac39-1706cbf8a869"
}
}
示例3 站点首次启用源站防护,并配置为指定四层代理实例启用特定回源 IP 网段回源
ZoneId 为 'zone-276zs184g93m' 的站点开启源站防护,并配置四层代理实例‘sid-19389e5dwwxfs’启用特定回源 IP 网段回源。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: EnableOriginACL
<公共请求参数>
{
"ZoneId": "zone-276zs184g93m",
"L4EnableMode": "specific",
"L4ProxyIds": [
"sid-19389e5dwwxfs"
]
}
输出示例
{
"Response": {
"RequestId": "9e0a2b4f-df6d-4d2a-ac39-1706cbf8a869"
}
}
示例4 站点首次启用源站防护,并配置站点下所有七层加速域名和四层代理实例启用特定回源 IP 网段回源
ZoneId 为 'zone-276zs184g93m' 的站点开启源站防护,并配置所有的七层加速域名和四层代理实例启用特定回源 IP 网段回源。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: EnableOriginACL
<公共请求参数>
{
"ZoneId": "zone-276zs184g93m",
"L7EnableMode": "all",
"L4EnableMode": "all"
}
输出示例
{
"Response": {
"RequestId": "9e0a2b4f-df6d-4d2a-ac39-1706wdf8a869"
}
}
示例5 站点首次启用源站防护,并配置站点下所有七层加速域名启用特定回源 IP 网段回源
ZoneId 为 'zone-276zs184g93m' 的站点开启源站防护,并配置所有的七层加速域名启用特定回源 IP 网段回源。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: EnableOriginACL
<公共请求参数>
{
"ZoneId": "zone-276zs184g93m",
"L7EnableMode": "all"
}
输出示例
{
"Response": {
"RequestId": "9e0a2b4f-df6d-4d2a-ac39-1706wdf8a869"
}
}
示例6 站点首次启用源站防护,并配置站点下所有四层代理实例启用特定回源 IP 网段回源
ZoneId 为 'zone-276zs184g93m' 的站点开启源站防护,并配置所有的四层代理实例启用特定回源 IP 网段回源。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: EnableOriginACL
<公共请求参数>
{
"ZoneId": "zone-276zs184g93m",
"L4EnableMode": "all"
}
输出示例
{
"Response": {
"RequestId": "9e0a2b4f-df6d-4d2a-ac39-1706wdf8a869"
}
}
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 | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.InvalidDomains | 域名非法,请检查入参中是否传入不存在的域名。 |
InvalidParameter.InvalidProxies | 四层代理非法,请检查入参中是否传入不存在的代理。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.UnsupportedPlan | 套餐不支持。 |
OperationDenied.VersionControlIsGraying | 存在使用中的测试版本,请将测试版本发布现网或者回滚测试版本再重试。 |
UnauthorizedOperation.CamUnauthorized | Cam 未授权。 |