1. 接口描述
接口请求域名: teo.tencentcloudapi.com 。
本接口为旧版,如需调用请尽快迁移至新版,详情请参考 创建四层代理转发规则 。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateApplicationProxyRule。 |
Version | 是 | String | 公共参数,本接口取值:2022-09-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
ZoneId | 是 | String | 站点ID。 |
ProxyId | 是 | String | 代理ID。 |
Proto | 是 | String | 协议,取值有: |
Port.N | 是 | Array of String | 端口,支持格式: |
OriginType | 是 | String | 源站类型,取值有: |
OriginValue.N | 是 | Array of String | 源站信息:["8.8.8.8","9.9.9.9"] 或 OriginValue=["test.com"] ;["lb-xdffsfasdfs"] ;["origin-537f5b41-162a-11ed-abaa-525400c5da15"] 。 |
ForwardClientIp | 否 | String | 传递客户端IP,取值有: |
SessionPersist | 否 | Boolean | 是否开启会话保持,取值有: |
SessionPersistTime | 否 | Integer | 会话保持的时间,只有当SessionPersist为true时,该值才会生效。 |
OriginPort | 否 | String | 源站端口,支持格式: |
RuleTag | 否 | String | 规则标签。默认值为空字符串。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RuleId | String | 规则ID |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建应用代理规则
创建应用代理规则
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateApplicationProxyRule
<公共请求参数>
{
"ZoneId": "zone-21xfqlh4qjee",
"ProxyId": "proxy-19389e5dwwxfs",
"Proto": "TCP",
"Port": [
"99-110"
],
"OriginType": "custom",
"OriginValue": [
"1.1.1.1"
],
"OriginPort": "99-110",
"ForwardClientIp": "TOA",
"SessionPersist": false,
"RuleTag": "rule-service-1"
}
输出示例
{
"Response": {
"RequestId": "3df3e931-3159-4337-adc7-7604e01e0fa9",
"RuleId": "rule-a8f0d49a-33d7-11ed-9b89-52540005c111"
}
}
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.ProxyServer | 后端服务器发生未知错误。 |
InvalidParameter.InvalidOriginIp | 不支持填写内网IP/回环地址作为源站地址 |
InvalidParameter.InvalidRuleProto | 规则协议错误。(TCP/UDP)。 |
InvalidParameter.ParameterError | 参数错误: 无效 "结束时间", 不在允许的查询范围内: [开始时间, 开始+ 7天] |
InvalidParameter.RuleOriginFormatError | 规则源站信息格式错误。 |
InvalidParameter.RuleOriginMultiDomain | 规则源站不支持多域名。 |
InvalidParameter.RuleOriginPortInteger | 规则源站端口应为整数。 |
InvalidParameter.RuleOriginValueError | 规则源站错误。 |
InvalidParameter.RulePortDuplicating | 规则端口重复。 |
InvalidParameter.RulePortGroup | 规则端口段错误。 |
InvalidParameter.RulePortInteger | 规则端口必须为整数。 |
OperationDenied | 操作被拒绝。 |
ResourceNotFound | 资源不存在。 |
UnauthorizedOperation.CamUnauthorized | Cam 未授权。 |