1. 接口描述
接口请求域名: teo.tencentcloudapi.com 。
本接口为旧版,如需调用请尽快迁移至新版 创建四层代理实例 。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateApplicationProxy。 |
Version | 是 | String | 公共参数,本接口取值:2022-09-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
ZoneId | 是 | String | 站点 ID。 |
ProxyName | 是 | String | 当 ProxyType=hostname 时,表示域名或子域名; 当 ProxyType=instance 时,表示代理名称。 |
PlatType | 是 | String | 调度模式,取值有: |
SecurityType | 是 | Integer | 是否开启安全,取值有: |
AccelerateType | 是 | Integer | 是否开启加速,取值有: |
ProxyType | 否 | String | 四层代理模式,取值有: |
SessionPersistTime | 否 | Integer | 会话保持时间,取值范围:30-3600,单位:秒。 不填写使用默认值600。 |
Ipv6 | 否 | Ipv6 | Ipv6 访问配置。 不填写表示关闭 Ipv6 访问。 |
ApplicationProxyRules.N | 否 | Array of ApplicationProxyRule | 规则详细信息。 不填写则不创建规则。 |
AccelerateMainland | 否 | AccelerateMainland | 中国大陆加速优化配置。不填写表示关闭中国大陆加速优化。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ProxyId | String | 新增的四层代理应用ID。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建应用代理
创建应用代理。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateApplicationProxy
<公共请求参数>
{
"ZoneId": "zone-21xfqlh4qjee",
"ProxyName": "instancd-name",
"ProxyType": "instance",
"PlatType": "ip",
"SecurityType": 1,
"AccelerateType": 1,
"SessionPersistTime": 3600,
"Ipv6": {
"Switch": "on"
},
"ApplicationProxyRules": [
{
"Proto": "TCP",
"Port": [
"80",
"90",
"99-110"
],
"OriginType": "custom",
"OriginValue": [
"1.1.1.1:80"
]
},
{
"Proto": "UDP",
"Port": [
"999",
"888",
"99-110"
],
"OriginType": "custom",
"OriginValue": [
"1.1.1.1:80",
"2.2.2.2:80"
]
}
]
}
输出示例
{
"Response": {
"RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707",
"ProxyId": "proxy-537f5b41-162a-11ed-abaa-525400c5da15"
}
}
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.InvalidOriginIp | 不支持填写内网IP/回环地址作为源站地址 |
InvalidParameter.ParameterError | 参数错误: 无效 "结束时间", 不在允许的查询范围内: [开始时间, 开始+ 7天] |
InvalidParameter.ProxyNameDuplicating | 实例名称重复。 |
InvalidParameter.ProxyNameNotMatched | 实例名称可输入1-50个字符,允许的字符为a-z、0-9、-,- 不能单独注册或连续使用,不能放在开头或结尾。 |
LimitExceeded | 超过配额限制。 |
LimitExceeded.UserQuotaLimited | 用户实例数量限制。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.ErrZoneIsAlreadyPaused | 站点处于停用状态,请开启后重试。 |
OperationDenied.PlatTypeIPAccelerateMainlandNotSupport | Anycast IP调度模式不支持开启中国大陆加速。 |
OperationDenied.ZoneNotActive | 站点未启用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |