1. 接口描述
接口请求域名: teo.tencentcloudapi.com 。
用于创建四层代理实例规则,支持单条或者批量创建。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateL4ProxyRules。 |
Version | 是 | String | 公共参数,本接口取值:2022-09-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
ZoneId | 是 | String | 站点 ID。 |
ProxyId | 是 | String | 四层代理实例 ID。 |
L4ProxyRules.N | 是 | Array of L4ProxyRule | 转发规则列表。单次最多支持 200 条转发规则。 注意:L4ProxyRule 在此处使用时,Protocol、PortRange、OriginType、OriginValue、OriginPortRange 为必填字段;ClientIPPassThroughMode、SessionPersist、SessionPersistTime、RuleTag 均为选填字段;RuleId、Status 请勿填写。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
L4ProxyRuleIds | Array of String | 新增转发规则的 ID,以数组的形式返回。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建四层代理转发规则
在 ZoneId 为 zone-24wjy25v1cwi 下 ProxyId 为 sid-2qwk27xf7j9g 的实例中创建一条转发规则。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateL4ProxyRules
<公共请求参数>
{
"ZoneId": "zone-24wjy25v1cwi",
"ProxyId": "sid-2qwk27xf7j9g",
"L4ProxyRules": [
{
"Protocol": "TCP",
"PortRange": [
"80"
],
"OriginType": "IP_DOMAIN",
"OriginValue": [
"119.23.100.45"
],
"OriginPortRange": "90",
"ClientIPPassThroughMode": "TOA",
"SessionPersist": "on",
"SessionPersistTime": 3600,
"RuleTag": "test"
}
]
}
输出示例
{
"Response": {
"RequestId": "6f8h5358-df6d-4d2a-ac39-1706cbf8a707",
"L4ProxyRuleIds": [
"rule-2qzkbvx3hxl1"
]
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameter.InvalidOriginIp | 不支持填写内网IP/回环地址作为源站地址 |
InvalidParameter.InvalidOriginValue | 源站错误或不存在。 |
InvalidParameter.RulePortDuplicating | 规则端口重复。 |
LimitExceeded.ProxyRulesLimitExceeded | 导入的规则数量超限制。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.L4PortLackOfResources | 四层端口资源售卖火爆,已售罄,正在加紧补货中,当前无法新增四层代理或添加规则,请您耐心等待。 |
ResourceNotFound | 资源不存在。 |