有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

接口请求域名: teo.tencentcloudapi.com 。

查询四层代理实例下的转发规则列表。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeL4ProxyRules。
Version String 公共参数,本接口取值:2022-09-01。
Region String 公共参数,此参数为可选参数。
ZoneId String 站点 ID。
ProxyId String 四层代理实例 ID。
Offset Integer 分页查询偏移量,不填写时默认为 0。
Limit Integer 分页查询限制数目。默认值:20,最大值:1000。
Filters.N Array of Filter 过滤条件,Filters.Values的上限为20。不填写时返回当前四层实例下所有的规则信息,详细的过滤条件如下:
  • rule-tag:按照规则标签对四层代理实例下的规则进行过滤。

  • 3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 转发规则总数。
    L4ProxyRules Array of L4ProxyRule 转发规则列表。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询四层代理实例转发规则列表

    查询 Zoneld 为 zone-24wjy25v1cwi 下 Proxyld 为 sid-2qwk27xf7j9g 下的转发规则列表。

    输入示例

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeL4ProxyRules
    <公共请求参数>
    
    {
        "ZoneId": "zone-24wjy25v1cwi",
        "ProxyId": "sid-2qwk27xf7j9g",
        "Offset": 1,
        "Limit": 0
    }

    输出示例

    {
        "Response": {
            "TotalCount": 1,
            "L4ProxyRules": [
                {
                    "RuleId": "rule-2qzkbvx3hxl1",
                    "Protocol": "TCP",
                    "PortRange": [
                        "80"
                    ],
                    "OriginType": "IP_DOMAIN",
                    "OriginValue": [
                        "119.23.100.45"
                    ],
                    "OriginPortRange": "90",
                    "ClientIPPassThroughMode": "TOA",
                    "SessionPersist": "on",
                    "SessionPersistTime": 3600,
                    "RuleTag": "test",
                    "Status": "online"
                }
            ],
            "RequestId": "6f8h5358-cdda-4f82-b7sc-0aef4a219244"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码