1. 接口描述
接口请求域名: teo.tencentcloudapi.com 。
本接口为旧版,如需调用请尽快迁移至新版,新版接口中将四层代理实例列表的查询和四层转发规则的查询拆分成两个接口,详情请参考 查询四层代理实例列表 和 查询四层代理转发规则列表。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeApplicationProxies。 |
Version | 是 | String | 公共参数,本接口取值:2022-09-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
ZoneId | 否 | String | 站点ID。该参数必填。 |
Filters.N | 否 | Array of Filter | 过滤条件,Filters.Values的上限为20。详细的过滤条件如下: 按照【代理ID】进行过滤。代理ID形如:proxy-ev2sawbwfd。 类型:String 必选:否 按照【站点ID】进行过滤。站点ID形如:zone-vawer2vadg。 类型:String 必选:否 按照【规则标签】对应用代理下的规则进行过滤。规则标签形如:rule-service-1。 类型:String 必选:否 |
Offset | 否 | Integer | 分页查询偏移量。默认为0。 |
Limit | 否 | Integer | 分页查询限制数目。默认值:20,最大值:1000。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ApplicationProxies | Array of ApplicationProxy | 应用代理列表。 |
TotalCount | Integer | 记录总数。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询应用代理列表
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApplicationProxies
<公共请求参数>
{
"Offset": 0,
"Limit": 10
}
输出示例
{
"Response": {
"RequestId": "a84ae15a-aca5-4c24-a4f4-c419cf2c18af",
"ApplicationProxies": [
{
"HostId": "",
"ProxyType": "instance",
"Area": "mainland",
"AccelerateType": 1,
"SessionPersistTime": 100,
"PlatType": "domain",
"ProxyId": "proxy-34c74aa7-9a9f-11ec-bcb0-52540015711d",
"ProxyName": "zone-f835533b8998f",
"ZoneId": "zone-21xfqlh4qjee",
"ZoneName": "123.com",
"ApplicationProxyRules": [
{
"OriginType": "custom",
"OriginValue": [
"81.69.174.153:80"
],
"Port": [
"80"
],
"OriginPort": "8080",
"SessionPersistTime": 100,
"Proto": "TCP",
"Status": "online",
"ForwardClientIp": "off",
"SessionPersist": true,
"RuleId": "rule-34c74ab8-9a9f-11ec-bcb0-52540015711d",
"RuleTag": "rule-for-cgi"
},
{
"OriginType": "custom",
"OriginValue": [
"81.69.174.153:553"
],
"Port": [
"553"
],
"Proto": "UDP",
"Status": "online",
"ForwardClientIp": "off",
"SessionPersist": true,
"OriginPort": "8080",
"SessionPersistTime": 100,
"RuleId": "rule-4bc1d3d6-9aa0-11ec-bcb0-52540015711d",
"RuleTag": "rule-for-logic"
}
],
"AccelerateMainland": {
"Switch": "off"
},
"ScheduleValue": [],
"SecurityType": 1,
"Ipv6": {
"Switch": "on"
},
"Status": "progress",
"BanStatus": "recover",
"UpdateTime": "2022-03-03T06:06:10Z"
}
],
"TotalCount": 1
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError.ProxyServer | 后端服务器发生未知错误。 |
OperationDenied | 操作被拒绝。 |
UnauthorizedOperation.CamUnauthorized | Cam 未授权。 |
UnauthorizedOperation.NoPermission | 子账户没有操作权限,请添加权限后继续操作。 |
UnauthorizedOperation.Unknown | 后端服务器发生未知错误。 |