1. 接口描述
接口请求域名: teo.tencentcloudapi.com 。
用于创建四层代理实例。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateL4Proxy。 |
Version | 是 | String | 公共参数,本接口取值:2022-09-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
ZoneId | 是 | String | 站点 ID。 |
ProxyName | 是 | String | 四层代理实例名称,可输入 1-50 个字符,允许的字符为 a-z、0-9、-,且 - 不能单独注册或连续使用,不能放在开头或结尾。创建完成后不支持修改。 |
Area | 是 | String | 四层代理实例加速区域。 |
Ipv6 | 否 | String | 是否开启 IPv6 访问,不填写时默认为 off。该配置仅在部分加速区域和安全防护配置下支持开启,详情请参考 新建四层代理实例 。取值为: |
StaticIp | 否 | String | 是否开启固定 IP,不填写时默认为 off。该配置仅在部分加速区域和安全防护配置下支持开启,详情请参考 新建四层代理实例 。取值为: |
AccelerateMainland | 否 | String | 是否开启中国大陆网络优化,不填写时默认为 off。该配置仅在部分加速区域和安全防护配置下支持开启,详情请参考 新建四层代理实例 。取值为: |
DDosProtectionConfig | 否 | DDosProtectionConfig | L3/L4 DDoS 防护配置,不填写时默认使用平台默认防护选项。详情参考 独立 DDoS 防护。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ProxyId | String | 四层实例 ID。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 新建加速区域为中国大陆可用区的四层代理实例
在 ZoneId 为 zone-2jc2xy3hr7f7 的站点下创建一个名称为 test,加速区域为中国大陆可用区的四层实例。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateL4Proxy
<公共请求参数>
{
"ProxyName": "test",
"ZoneId": "zone-2jc2xy3hr7f7",
"Area": "mainland"
}
输出示例
{
"Response": {
"ProxyId": "sid-2jc2hl2hr8f7",
"RequestId": "0se57a54-cc42-11ed-8efb-525401a961b1"
}
}
示例2 新建加速区域为全球可用区(不含中国大陆),开启独立 DDoS 防护的四层代理实例
在 ZoneId 为 zone-2jc2xy3hr7f7 的站点下创建一个名称为 test,加速区域为全球可用区(不含中国大陆)的四层实例,且开启独立 DDoS 防护,提供加速区域范围的全力防护。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateL4Proxy
<公共请求参数>
{
"ZoneId": "zone-2jc2xy3hr7f7",
"ProxyName": "test",
"Area": "overseas",
"DDosProtectionConfig": {
"LevelOverseas": "ANYCAST_ALLIN"
}
}
输出示例
{
"Response": {
"ProxyId": "sid-2jc2hl2hr8f7",
"RequestId": "0se57a54-cc42-11ed-8efb-525401a961b1"
}
}
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 | 操作失败。 |
InvalidParameter.ProxyNameDuplicating | 实例名称重复。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.AccelerateMainlandDisable | 功能内测中,请联系商务开启「中国大陆网络优化(国际加速)」功能。 |
OperationDenied.AccelerateMainlandIpv6Conflict | 中国大陆加速与IPv6冲突,不能同时配置。 |
OperationDenied.ErrZoneIsAlreadyPaused | 站点处于停用状态,请开启后重试。 |
OperationDenied.Ipv6AdvancedConflict | 独立DDoS防护与IPv6冲突,不能同时配置。 |
OperationDenied.Ipv6StaticIpConflict | ipv6功能和固定ip无法同时开启。 |
OperationDenied.L4LackOfResources | 四层实例资源售卖火爆,已售罄,正在加紧补货中,当前无法新增四层代理,请您耐心等待。 |
OperationDenied.MsgIpv6AdvancedConflict | 非海外独立防护,不能开启ipv6。 |
OperationDenied.StaticIpAreaConflict | 该实例地域无法开启固定IP。 |
UnauthorizedOperation.CamUnauthorized | Cam 未授权。 |